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

checkpoint: begin writing the user manual

Browse source
This commit is contained in:
Dan Anglin 2024-07-01 19:15:01 +01:00
parent 1541aa6936
commit 64c1dbcf51
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638
1 changed files with 108 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

109
docs/manual.md
View file

@ -6,4 +6,111 @@ SPDX-License-Identifier: CC-BY-4.0
# User Manual
_Coming soon_
## Version
### Print the application version
View the application's version and build information
```
enbas version --full
```
| flag | type | required | description | default |
|------|------|----------|-------------|---------|
| `full` | boolean | false | Prints the full build information. | false |
## Authentication
### Logging into an account
Log into your GoToSocial account. You can run this multiple times to log into multiple accounts.
```
enbas login --instance gts.enbas-demo.private
```
| flag | type | required | description | default |
|------|------|----------|-------------|---------|
| `instance` | string| true | The instance that you wan to log into. | |
### Switch between accounts
Switch between your logged in accounts.
```
enbas switch --to account --account-name vincent@gts.enbas-demo.private
```
| flag | required | description | default |
|------|----------|-------------|---------|
| `to` | true | the resource you want to switch to. in this case you want `account`. | |
| `account-name` | true | the name of the account you want to switch to | |
### See the account that you are currently logged in as
```
enbas whoami
```
## Accounts
### View an account
### Follow an account
### Unfollow an account
### Block an account
### Unblock an account
### Mute an account
### Unmute an account
## Statuses
### View a status
### Create a status
### Create a status with a poll
### Delete a status
_Not yet implemented_
### Boost (Reblog) a status
To boost a status you simply add a 'boost' to it.
### Un-boost (Un-reblog) a status
To un-boost a status that you've boosted you simply remove the 'boost' from it.
### Like/Star/Favourite a status
## Polls
### View a poll
### Vote in a poll
## Timelines
## Lists
### Create a list
### Edit a list
### Delete a list
### Add an account to a list
### Remove an account from a list
## Bookmarks
### Add a status to your bookmarks
### Remove a status from your bookmarks