From 3688567e96f17ac032f7597fede7b6ea5b61c13f Mon Sep 17 00:00:00 2001 From: Junko Date: Thu, 30 Nov 2023 17:49:06 +0100 Subject: [PATCH] made docs more readable --- README.org | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.org b/README.org index 5a344ad..3a98281 100644 --- a/README.org +++ b/README.org @@ -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