Browse Source

Update 'README.md'

paologalli 5 years ago
parent
commit
3abfdd8853
1 changed files with 11 additions and 0 deletions
  1. 11 0
      README.md

+ 11 - 0
README.md

@@ -1,2 +1,13 @@
 # lcmlog
+Client side of a tool for reading and writing the lcm staff logs (both admins and 150).
+## The three methods
+All these procedures are guided: the script will assist you during the upload or the search.
 
+### GET
+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.
+
+### 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.