diff --git a/docs/manual.md b/docs/manual.md index 9c389a8..114747f 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -132,7 +132,7 @@ enbas whoami ### View your own account -Print the information of your own account. +Prints the information from your own account. ``` enbas show --type account --my-account @@ -191,11 +191,39 @@ enbas unfollow --type account --account-name @name@example.social ### Show an account's followers -_TODO: provide instructions after updated implementation_ +- View followers of your own account. + ``` + enbas show --type followers --from account --my-account + ``` +- View followers of another account. + ``` + enbas show --type followers --from account --account-name @name@example.social + ``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to view. Here this should be `followers`. | | +| `from` | string | true | The resource you want to view followers from.
Here this should be `account`. | | +| `my-account` | boolean | false | Set to `true` to view followers from your own account.
This takes precendence over `account-name`.| false | +| `account-name` | string | true | The name of the account to get the followers from. | | ### Show account's followings -_TODO: provide instructions after updated implementation_ +- View the accounts that you are following. + ``` + enbas show --type following --from account --my-account + ``` +- View the accounts that another account is following. + ``` + enbas show --type following --from account --account-name @name@example.social + ``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to view. Here this should be `following`. | | +| `from` | string | true | The resource you want to view the followings from.
Here this should be `account`. | | +| `my-account` | boolean | false | Set to `true` to view the list from your own account.
This takes precendence over `account-name`.| false | +| `account-name` | string | true | The name of the account to get the list from. | | ### Block an account @@ -395,7 +423,7 @@ enbas show --type poll --poll-id 01J0CEEZBZ6E6AYQSJPHCQYBDA Add your vote(s) to a poll. ``` -enbas add --type vote --to poll --poll-id 01J1TVJ705VV3VP02FVVBSMX7E --choose 3 +enbas add --type vote --to poll --poll-id 01J1TVJ705VV3VP02FVVBSMX7E --vote 3 ``` | flag | type | required | description | default | @@ -403,7 +431,7 @@ enbas add --type vote --to poll --poll-id 01J1TVJ705VV3VP02FVVBSMX7E --choose 3 | `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. | | +| `vote` | 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. | | ## Lists