From cfe6fe3e8d86c6e3651ae2a235dfe22b75e785da Mon Sep 17 00:00:00 2001 From: Dan Anglin Date: Wed, 3 Jul 2024 13:16:41 +0100 Subject: [PATCH] private note --- docs/manual.md | 36 +++++++++++++++++++++++++++++++----- 1 file changed, 31 insertions(+), 5 deletions(-) diff --git a/docs/manual.md b/docs/manual.md index f6ff4bd..9c389a8 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -147,7 +147,7 @@ enbas show --type account --my-account ### View an account Prints the information of a local or a remote account. -If the account is unknown by your instance a `404` message will be returned. +If the account is unknown by your instance a `404` message will be shown instead. ``` enbas show --type account --account-name @name@example.social @@ -157,7 +157,7 @@ enbas show --type account --account-name @name@example.social |------|------|----------|-------------|---------| | `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 | +| `skip-relationship` | boolean | false | Set to `true` to skip viewing your relationship to the account you are viewing (including the private note if you've created one). | false | ### Follow an account @@ -189,15 +189,14 @@ enbas unfollow --type account --account-name @name@example.social | `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. | | -### Show followers of an account +### Show an account's followers _TODO: provide instructions after updated implementation_ -### Show who an account is following +### Show account's followings _TODO: provide instructions after updated implementation_ - ### Block an account ``` @@ -270,6 +269,33 @@ enbas show --type muted-accounts | `type` | string | true | The resource you want to view.
Here this should be `muted-accounts`. | | | `limit` | integer | false | The maximum number of accounts to print. | 20 | +### Add a private note to an account + +Adds a private note to an account. Private notes can only be viewed by you. + +``` +enbas add --type note --to account --account-name @name@example.social --content "This person is awesome." +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to add.
Here this should be `note`. | | +| `to` | string | true | The resource you want to add the note to.
Here this should be `account`. | | +| `account-name` | string | true | The name of the account that you want to add the note to. | | +| `content` | string | true | The content of the note. | | + +### Remove the private note from an account + +``` +enbas remove --type note --from account --account-name @name@example.social +``` + +| flag | type | required | description | default | +|------|------|----------|-------------|---------| +| `type` | string | true | The resource you want to remove.
Here this should be `note`. | | +| `from` | string | true | The resource you want to remove the note to.
Here this should be `account`. | | +| `account-name` | string | true | The name of the account that you want to remove the note from. | | + ## Follow requests ### View your follow requests