documentation

README.md

@@ -1,33 +1,38 @@
-## About Parse-Edi
+## About Healthcare/IO Parser
 
-**parse-edi** is an Electronic Data Interchange (EDI) parser developed at Vanderbilt University Medical Center during Khanhly Nguyen's summer internship 2019. Built in a healthcare setting, the parser focuses (for now) on x12 claims (837) and remittances (835)
+The Halthcare/IO **parser** is an Electronic Data Interchange (EDI) parser developed at Vanderbilt University Medical Center during Khanhly Nguyen's summer internship 2019. Built in a healthcare setting, the parser focuses (for now) on x12 claims (837) and remittances (835)
 
 This code is intended to extract x12 837 and 835 and format them into portable and human readable format (JSON). This allows the claims to be stored in document data stores such as Mongodb, couchdb or databases that have support for JSON like PostgreSQL
 
 We wrote this frame to be used in both command line or as a library within in your code. The framework is driven by configurations that derviced from X12 standards.
 
-
-
+## Features ## 
+    | Features | |
+    |----------|-|
 ## Installation
 
-    pip install git+https://hiplab.mc.vanderbilt.edu/git/lab/parse-edi.git
-
-
+    pip install --upgrade git+https://hiplab.mc.vanderbilt.edu/git/lab/parse-edi.git
 
 ## Usage 
 
-**Commandline :**
+**cli :**
 
+        # signup to get parsing configuration
+        healthcare-io.py --signup <email> [--store <mongo|sqlite>]
         
-        python edi --config <path> --folder <path> --store <[mongo|disk|couch]> --<db|path]> <id|path>
+        #
+        # start parsing claims in a folder
+        healthcare-io.py --parse <claims|remits> --folder <path> [--batch <n>] [--resume]
         
         with :
-            --scope     <claims|remits>
-            --config    path of the x12 to be parsed i.e it could be 835, or 837
-            --folder    location of the files (they must be decompressed)
-            --store     data store could be disk, mongodb, couchdb
-            --db|path    name of the folder to store the output or the database name
-    
+            --parse     tells the engine what to parse claims or remits
+            --folder    location of the claims|remits
+            --batch     number of processes to spawn to parse the files
+            --resume    tells the parser to resume parsing 
+                        if all files weren't processed or new files were added into the folder
+**dashboard**
+    There is a built-in dashboard that has features
+    healthcare-io.py --server <port> [--context <name>]    
 **Embedded in Code   :**
 
 Use **parse-edi** within your code base as a library and handle storing data in a data store of choice