From 7e9da13ea94264d59554ba39e2ba54a41778637a Mon Sep 17 00:00:00 2001 From: Storm Dragon Date: Tue, 29 Jul 2025 19:25:37 -0400 Subject: [PATCH] Documentation updates. --- Basic-Usage.md | 39 +++++++++++++++++++++++++++ Commands-Reference.md | 62 ++++++++++++++++++++++++++++++++++++++++--- Quick-Commands.md | 10 +++++++ 3 files changed, 108 insertions(+), 3 deletions(-) diff --git a/Basic-Usage.md b/Basic-Usage.md index ba53e2f..4cb9fa7 100644 --- a/Basic-Usage.md +++ b/Basic-Usage.md @@ -134,6 +134,45 @@ Enter alt text for sunset.jpg: Orange and purple clouds over mountains during go Enter post message (optional): Beautiful evening hike in the local mountains ``` +### Creating Polls + +TTYverse supports both single and multiple choice polls: + +**Single choice poll (users pick one option):** +```bash +/poll What's your favorite season? +``` + +**Multiple choice poll (users can pick multiple options):** +```bash +/mpoll Which TTYverse features do you use? (select all that apply) +``` + +**Interactive poll creation process:** +``` +TTYverse> /poll What's your favorite programming language? +Creating single choice poll: What's your favorite programming language? +Poll duration (default 24h): 3d +Enter options (press Enter with no text to finish): +Option 1: Python +Option 2: JavaScript +Option 3: Rust +Option 4: Go +Option 5: [press Enter to finish] +-- Poll posted successfully +``` + +**Duration formats:** +- `24h` = 24 hours +- `3d` = 3 days +- `90m` = 90 minutes +- Empty = 24 hours (default) + +**Poll limitations:** +- Each option: maximum 50 characters +- Minimum 2 options required +- Most instances limit to 4 options + ### Replying to Conversations ```bash # Reply to someone's post diff --git a/Commands-Reference.md b/Commands-Reference.md index 32732e3..d76f899 100644 --- a/Commands-Reference.md +++ b/Commands-Reference.md @@ -73,6 +73,54 @@ Upload media (image, audio, video) with optional post text. - **Audio:** MP3, OGG, WAV, FLAC, M4A - **Video:** MP4, WebM, MOV +### `/poll ` +Create a single choice poll where users can select one option. + +**Usage:** +```bash +/poll What's your favorite programming language? +``` + +**Interactive process:** +1. Enter poll question after `/poll` +2. Set poll duration (default 24h): `3d`, `12h`, `90m`, or press Enter +3. Enter options one by one (up to 10, though most instances limit to 4) +4. Press Enter on empty line to finish and post + +**Duration formats:** +- `24h` - 24 hours +- `3d` - 3 days +- `90m` - 90 minutes +- Default: 24 hours if left empty + +**Limitations:** +- Each option limited to 50 characters +- Minimum 2 options required +- Most instances limit to 4 options (TTYverse allows up to 10) + +### `/mpoll ` +Create a multiple choice poll where users can select multiple options. + +**Usage:** +```bash +/mpoll Which features do you use most? (select all that apply) +``` + +**Process:** Same as `/poll` but creates a multiple choice poll where voters can select multiple options. + +**Example workflow:** +```bash +TTYverse> /poll Choose your favorite color +Creating single choice poll: Choose your favorite color +Poll duration (default 24h): 2d +Enter options (press Enter with no text to finish): +Option 1: Red +Option 2: Blue +Option 3: Green +Option 4: [press Enter] +-- Poll posted successfully (ID: 01K1BWFGCB...) +``` + ## Interaction Commands ### `/boost ` @@ -110,11 +158,17 @@ Vote in a poll. **Usage:** ```bash -/vote a3 1 # Vote for option 1 -/vote b2 2,3 # Vote for options 2 and 3 (multiple choice) -/vote c1 1-3 # Vote for options 1 through 3 +/vote a3 1 # Vote for option 1 (single choice poll) +/vote b2 2,3 # Vote for options 2 and 3 (multiple choice poll) +/vote c1 1-3 # Vote for options 1 through 3 (multiple choice poll) ``` +**Notes:** +- **Single choice polls:** Only one option can be selected +- **Multiple choice polls:** Multiple options can be selected using commas or ranges +- **Poll identification:** Polls are marked with `[Poll]` in the post display +- **Vote status:** Shows "(multiple choice)" for multiple choice polls + ## Direct Messages ### `/dms` @@ -263,6 +317,8 @@ Some commands have shorter aliases: - `/boost` = `/reblog` - `/dms` = `/dm` - `/quit` = `/exit` = `/q` +- `/poll` = single choice poll +- `/mpoll` = multiple choice poll ## Tips diff --git a/Quick-Commands.md b/Quick-Commands.md index b6156c7..e169d68 100644 --- a/Quick-Commands.md +++ b/Quick-Commands.md @@ -25,6 +25,8 @@ Hello world! # Create a public post ```bash /media /path/image.jpg # Upload image (requires alt-text) /media /path/audio.mp3 # Upload audio file +/poll What's your favorite? # Create single choice poll +/mpoll Pick all you like # Create multiple choice poll /url a3 # Open URL from post a3 ``` @@ -137,6 +139,14 @@ Posts show their visibility level: /bookmark a3 # Save for later ``` +### Creating Polls +```bash +/poll Your question? # Start single choice poll +# Enter duration (24h, 3d, 90m) or press Enter for 24h +# Enter options one by one, press Enter to finish +/mpoll Multi-choice? # Same process, allows multiple votes +``` + ### Managing Timeline ```bash /timeline bookmarks # See saved posts