Update README.md

README.md

@@ -1 +1,14 @@
-# radx-data-dictionary-analysis
+# RADx Data Dictionary Analysis
+
+A repository for the analysis of various RADx data dictionaries.  The repo contains a folder called "curated" that contains a collection of cleaned data dictionaries by Data Collection Center (DCC).  To process the data dictionaries run the "process-data-dictionaries.sh" script.  The processing will produce a series of folders containing intermediate processed data dictionaries and then a merge of all data dictionaries in a file called `merged.csv`.
+
+To run the script, in this repository root directory (after cloning the repo), type:
+
+```
+./process-data-dictionaries.sh ./curated ./generated
+```
+
+## RADx Data Dictionary Explorer Tool
+
+This script requires the [RADx Data Dictionary Explorer](https://github.com/RADx/radx-data-dictionary-explorer) command line tool.  The script uses an alias `dd` to this tool.  You should build and install the tool and then set up an alias to the tool.
+