Browse Source

Update 'README.md'

paologalli 4 years ago
parent
commit
cd3fd107b8
1 changed files with 4 additions and 3 deletions
  1. 4 3
      README.md

+ 4 - 3
README.md

@@ -7,7 +7,7 @@ Client side of a tool for reading and writing the lcm staff logs (both admins an
 The `GET` method is called with the `-g` option and is used to print all the logs that meet the required criteria.
 
 #### POST
-The `POST` method is called with the `-p` option and is used to add a log to the database. Accented characters are allowed and automatically transformed using quotes.
+The `POST` method is called with the `-p` option and is used to add a log to the database. Accented characters are allowed and automatically transformed using quotation marks or backticks.
 
 #### UPDATE
 The `UPDATE` method is called with the `-u` option and is used to regenerate the internal server database. It should only be called if a log file is added by hand, or if some of the log files get renamed or corrupted. It assumes that all the log files are correctly formatted. **CURRENTLY NOT WORKING**.
@@ -36,7 +36,8 @@ After the generation, you should edit the file and add the correct `HostName` (a
 You can't use this program until the config file is generated in the default folder (`~/.config/lcmlog`).
 
 ## Editor
-The default editor is `nano`. If you want to use another editor, now I have to edit the source code and change the variable `EDITOR`. In a future update, this customization will be included in the configuration file.
+The default editor is `nano`. If you want to use another editor, currently you have to edit the source code and change the variable `EDITOR`. In a future update, this customization will be included in the configuration file.
 
 ## TODO
-- Implement custom editor in the configuration file.
+[ ] Implement custom editor in the configuration file.
+[ ] Implement the `UPDATE` method