about summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2021-07-29 20:41:28 +0530
committerAndinus <andinus@nand.sh>2021-07-29 20:41:28 +0530
commit206c0aab0ed1f99cad242a147390c489c56ee605 (patch)
treee95f127e41cf883f65a13d38729f384e5cbff7c6 /README
parent58ca87ee67262101fb3fa3cf7b855dc4443f90e9 (diff)
downloadlacerta-206c0aab0ed1f99cad242a147390c489c56ee605.tar.gz
Update README
Diffstat (limited to 'README')
-rw-r--r--README26
1 files changed, 20 insertions, 6 deletions
diff --git a/README b/README
index 7cbbb65..ca3bc42 100644
--- a/README
+++ b/README
@@ -83,18 +83,32 @@ Documentation
 Implementation
 ──────────────
 
-  Just enter the player names & it'll print each throw along with
-  scores. Press enter to play another round.
+  It reads the log line by line and tries to match it with `WhatsApp'
+  grammar.
 
 
 Options
 ───────
 
-players
-╌╌╌╌╌╌╌
+input
+╌╌╌╌╌
 
-  Number of players. Default is 2, should be an integer equal to or
-  greater than 2.
+  Exported WhatsApp log.
+
+
+profile-name
+╌╌╌╌╌╌╌╌╌╌╌╌
+
+  Your WhatsApp profile name. This is required to get stats for /Left/
+  and /Deleted/ column.
+
+
+Caveats
+───────
+
+  /Words/ count can be less than the actual count. If the message
+  contains new lines then they have them in the log too. We read the log
+  line by line, so it'll miss parts of messages with newline in them.
 
 
 News