apollo/enbas
1
0
Fork 0
Code Issues 4 Pull requests Projects Activity Actions

updated manual

Browse source
This commit is contained in:
Dan Anglin 2024-08-13 23:17:59 +01:00
parent 2f530bca5a
commit 326d3e2576
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638
1 changed files with 18 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
docs/manual.md
View file

@ -39,6 +39,7 @@
- [View a list of statuses that you've liked](#view-a-list-of-statuses-that-youve-liked) - [View a list of statuses that you've liked](#view-a-list-of-statuses-that-youve-liked)
- [Mute a status](#mute-a-status) - [Mute a status](#mute-a-status)
- [Unmute a status](#unmute-a-status) - [Unmute a status](#unmute-a-status)
- [Vote in a poll within a status](#vote-in-a-poll-within-a-status)
- [Polls](#polls) - [Polls](#polls)
- [Create a poll](#create-a-poll) - [Create a poll](#create-a-poll)
- [View a poll](#view-a-poll) - [View a poll](#view-a-poll)
@ -528,6 +529,21 @@ _Not yet supported_
_Not yet supported_ _Not yet supported_
### Vote in a poll within a status
Adds your vote(s) to a poll within a status.
```
enbas add --type vote --to status --status-id 01J55XVV2MM6MKQ7QHFBAVAE8R --vote 3
```
| flag | type | required | description | default |
|------|------|----------|-------------|---------|
| `type` | string | true | The resource you want to add.<br>Here this should be `vote`. | |
| `to` | string | true | The resource you want to add the vote to.<br>Here this should be `poll`. | |
| `status-id` | string | true | The ID of the poll you want to add the votes to. | |
| `vote` | int | true | The ID of the option that you want to vote for.<br>You can use this flag multiple times to vote for more than one option if the poll allows multiple choices. | |
## Polls ## Polls
### Create a poll ### Create a poll
@ -536,22 +552,11 @@ See [Create a status](#create-a-status).
### View a poll ### View a poll
You can view a poll from a status or timeline. You can view a poll within a [status](#view-a-status) or within a [timeline](#view-a-timeline).
### Vote in a poll ### Vote in a poll
Add your vote(s) to a poll. See [Vote in a poll within a status](#vote-in-a-poll-within-a-status)
```
enbas add --type vote --to poll --poll-id 01J1TVJ705VV3VP02FVVBSMX7E --vote 3
```
| flag | type | required | description | default |
|------|------|----------|-------------|---------|
| `type` | string | true | The resource you want to add.<br>Here this should be `vote`. | |
| `to` | string | true | The resource you want to add the vote to.<br>Here this should be `poll`. | |
| `poll-id` | string | true | The ID of the poll you want to add the votes to. | |
| `vote` | int | true | The ID of the option that you want to vote for.<br>You can use this flag multiple times to vote for more than one option if the poll allows multiple choices. | |
## Lists ## Lists