junkyard
/
pluralsync
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

made docs more readable

This commit is contained in:
Junko 2023-11-30 17:49:06 +01:00
parent 7e0366f09c
commit 3688567e96
1 changed files with 5 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.org
View File

@ -30,22 +30,17 @@ On the first run, if it does not exist, PluralSync will create a configuration d
Just fill it with PluralKit and SimplyPlural tokens associated to your account.
** Commands
- Sync
Once the configuration is ready, you can start by calling the =sync= command, which will get the list of members of the system and place their data in a =system.json= file inside the configuration folder. Running commands like =set= or =add= without a present =system.json= will automatically fetch the data for you.
- *Sync* - Once the configuration is ready, you can start by calling the =sync= command, which will get the list of members of the system and place their data in a =system.json= file inside the configuration folder. Running commands like =set= or =add= without a present =system.json= will automatically fetch the data for you.
*Remember to sync whenever you change the information of the system! i.e. adding a new member, rename...*
- Set
Takes multiple arguments. Sets the current front to the selected list of members.
- *Set* - Takes multiple arguments. Sets the current front to the selected list of members.
- Add
Takes multiple arguments. Adds the selected members to an already existing front.
- *Add* - Takes multiple arguments. Adds the selected members to an already existing front.
- Get
Displays the current front. The result is displayed in console but also stored in a plain text file named =.front= in the configuration directory, for use with other applications (Polybar, OBS...).
- *Get* - Displays the current front. The result is displayed in console but also stored in a plain text file named =.front= in the configuration directory, for use with other applications (Polybar, OBS...).
- Memberlist
Writes the known list of members based on the =system.json= file.
- *Memberlist* - Writes the known list of members based on the =system.json= file.
** Modules
*** PFP module