Updated README for RocketChat

README.md

@@ -1,6 +1,6 @@
 # ninja-points
 
-This repo helps us calculate point values from contributions to our github and trello spaces.
+This repo helps us calculate point values from contributions from our various communication channels.
 
 ## GitHub contributions
 
@@ -83,8 +83,8 @@ First, get an API key [here](https://trello.com/app-key)
 Then, configure the following variables:
 
 ```
-TRELLO_API_KEY = '<API_KEY>'
-TRELLO_API_TOKEN = '<API_TOKEN>'
+export TRELLO_API_KEY='<API_KEY>'
+export TRELLO_API_TOKEN='<API_TOKEN>'
 ```
 
 Execute the script:
@@ -108,3 +108,41 @@ To limit to a specific user, the `--username` parameter can be specified.
 Additional queries can be generated by referencing the following:
 
 http://help.trello.com/article/808-searching-for-cards-all-boards
+
+## RocketChat
+
+### Script
+
+A script called [rocketchat.py](rocketchat.py) is available to automate statistics from [RocketChat](https://rocket.chat/).
+
+Configure the following variables:
+
+```
+export ROCKETCHAT_USERNAME='<ROCKETCHAT_USERNAME>'
+export ROCKETCHAT_PASSWORD='<ROCKETCHAT_PASSWORD>'
+```
+
+Execute the script:
+
+```
+$ ./rocketchat.py -d 2 -f "#cop-channel" 
+=== Rocketchat Statistics For 03/27/2018 - 03/29/2018 ===
+
+#emerging-tech
+  2 Users Joined
+  0 Users Removed
+  14 Messages
+    * jdoe - 64.29% - 9 Messages
+    * mmurray - 28.57% - 4 Messages
+    * csmart - 7.14% - 1 Message
+#dev-ops
+  8 Users Joined
+  1 Users Removed
+  10 Messages
+    * jdoe - 40.00% - 4 Messages
+    * mmurray - 30.00% - 3 Messages
+    * csmart - 20.00% - 2 Messages
+    * ashore - 10.00% - 1 Message
+```
+
+The script queries channels with a particular description as specified by the `-f` parameter and the number of days to search in the past using the `-d` parameter.