From 62f49bd8bc4519b408aa3c5678640f50ecde175a Mon Sep 17 00:00:00 2001 From: Dan Anglin Date: Wed, 3 Jul 2024 00:50:27 +0100 Subject: [PATCH] polls --- README.md | 8 ++++---- docs/manual.md | 48 ++++++++++++++++++++++++++++++++++++++++-------- 2 files changed, 44 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0801370..39bece4 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,10 @@ the `main` branch mirrored to the following forges: ### Documentation -- **[Installation guide](./docs/installation.md)**: A guide for installing Enbas on your machine. -- **[Getting started guide](./docs/getting_started.md)**: A guide to help you get started on using Enbas. -- **[Configuration reference](./docs/configuration.md)**: The configuration reference documentation. -- **[User manual](./docs/manual.md)**: The user manual. +- **[Installation guide](docs/installation.md)**: A guide for installing Enbas on your machine. +- **[Getting started guide](docs/getting_started.md)**: A guide to help you get started on using Enbas. +- **[Configuration reference](docs/configuration.md)**: The configuration reference documentation. +- **[User manual](docs/manual.md)**: The user manual. ### Licensing diff --git a/docs/manual.md b/docs/manual.md index b88a441..b9dbec5 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -76,7 +76,7 @@ enbas login --instance gts.enbas-demo.private | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `instance` | string | true | The instance that you wan to log into. | | +| `instance` | string | true | The instance that you want to log into. | | ### Switch between accounts @@ -109,7 +109,7 @@ enbas show --type account --my-account | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to view. In this case you want `account`. | | +| `type` | string | true | The resource you want to view. Here this should be `account`. | | | `my-account` | boolean | true | Use this flag to view your own account. | | | `show-preferences` | boolean | false | Show your posting preferences. | false | @@ -124,7 +124,7 @@ enbas show --type account --account-name @name@example.social | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to view. In this case you want `account`. | | +| `type` | string | true | The resource you want to view. Here this should be `account`. | | | `account-name` | string | true | The name of the account to view. | | | `skip-relationship` | boolean | false | Set to `true` to skip viewing your relationship to the account you are viewing. | false | @@ -138,7 +138,7 @@ enbas follow --type account --account-name @name@example.social | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to follow. In this case you want `account`. | | +| `type` | string | true | The resource you want to follow. Here this should be `account`. | | | `account-name` | string | true | The name of the account to follow. | | | `show-reposts` | boolean | false | Show reposts from the account you want to follow. | true | | `notify` | boolean | false | Get notifications when the account you want to follow posts a status. | false | @@ -155,7 +155,7 @@ enbas unfollow --type account --account-name @name@example.social | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to unfollow. In this case you want `account`. | | +| `type` | string | true | The resource you want to unfollow. Here this should be `account`. | | | `account-name` | string | true | The name of the account to unfollow. | | ### Block an account @@ -166,7 +166,7 @@ enbas block --type account --account-name @name@example.social | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to block. In this case you want `account`. | | +| `type` | string | true | The resource you want to block. Here this should be `account`. | | | `account-name` | string | true | The name of the account to block. | | ### Unblock an account @@ -177,7 +177,7 @@ enbas unblock --type account --account-name @name@example.social | flag | type | required | description | default | |------|------|----------|-------------|---------| -| `type` | string | true | The resource you want to unblock. In this case you want `account`. | | +| `type` | string | true | The resource you want to unblock. Here this should be `account`. | | | `account-name` | string | true | The name of the account to unblock. | | ### View blocked accounts @@ -242,7 +242,7 @@ enbas show --type muted-accounts ### Delete a status -_Not yet implemented_ +_Not yet supported_ ### Boost (Repost) a status @@ -262,10 +262,42 @@ To unlike (un-favourite) a status that you've previously liked you simply remove ## Polls +### Create a poll + +See [Create a status](#create-a-status). + ### View a poll +Prints the poll information to the screen. + +``` +enbas show --type poll --poll-id 01J0CEEZBZ6E6AYQSJPHCQYBDA +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to view.
Here this should be `poll`. | | +| `poll-id` | string | true | The ID of the poll that you want to view. | | + ### Vote in a poll +Add your vote(s) to a poll. + +``` +enbas add --type vote --to poll --poll-id 01J1TVJ705VV3VP02FVVBSMX7E --choose 3 +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to add.
Here this should be `vote`. | | +| `to` | string | true | The resource you want to add the vote to.
Here this should be `poll`. | | +| `poll-id` | string | true | The ID of the poll you want to add the votes to. | | +| `choose` | int | true | The ID of the option that you want to vote for.
You can use this flag multiple times to vote for more than one option if the poll allows multiple choices. | | + +## Media + +### View media from a status + ## Timelines ## Lists