Skip to content

README: document share --views and --expire #147

Description

@Maxerns

Why this is a good first issue

Quick start shows `sotto share DATABASE_URL` (one view, no expiry). The CLI already takes `--views` and `--expire` (see `crates/cli/src/main.rs`). Nobody finds those flags without `--help`.

Copy only.

What to do

In README.md, immediately under the Quick start snippet, add two example lines (in the block or as a second tiny block):

sotto share DATABASE_URL --views 3
sotto share DATABASE_URL --expire 3600   # lifetime in seconds

One sentence: the default is one view and no expiry; the link burns after the last view.

British English, no em dashes.

Out of scope

Do not document `--passphrase`. Do not change share defaults. Skip the landing-page terminal transcript (that block is a real session, not a flags catalogue).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions