checkpoint: begin writing the user manual
This commit is contained in:
parent
d52bb3fdf4
commit
5455f2bb4f
1 changed files with 108 additions and 1 deletions
109
docs/manual.md
109
docs/manual.md
|
@ -6,4 +6,111 @@ SPDX-License-Identifier: CC-BY-4.0
|
||||||
|
|
||||||
# User Manual
|
# 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
|
||||||
|
|
Loading…
Reference in a new issue