added --desc to README

mhowison · May 5, 2019 · 2269dae · 2269dae
1 parent f091b3f
commit 2269dae
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,14 @@ Usage:
 
     codebooks -o output.html input.csv
 
+## Adding variable descriptions
+
+You can specify a csv file that maps variable names to descriptions using:
+
+    codebooks --desc descriptions.csv -o output.html input.csv
+
+The csv file is expected to have two columns (variable name, description).
+
 ## License
 
 3-Clause BSD (see LICENSE)