update project structure

README.rst

@@ -246,27 +246,26 @@ Structure
 
 .. code-block:: bash
 
-    # output w/ JSON
-    {XDG data dir}/unihan_etl/unihan.json
-
-    # output w/ CSV
-    {XDG data dir}/unihan_etl/unihan.csv
-
-    # output w/ yaml (requires pyyaml)
-    {XDG data dir}/unihan_etl/unihan.yaml
-
-    # script to download + build a SDF csv of unihan.
-    unihan_etl/process.py
-
-    # unit tests to verify behavior / consistency of builder
+    # cache dir (Unihan.zip is downloaded, contents extracted)
+    {XDG cache dir}/unihan_etl/
+
+    # output dir
+    {XDG data dir}/unihan_etl/
+      unihan.json
+      unihan.csv
+      unihan.yaml   # (requires pyyaml)
+
+    # package dir
+    unihan_etl/
+      process.py    # argparse, download, extract, transform UNIHAN's data
+      constants.py  # immutable data vars (field to filename mappings, etc)
+      expansion.py  # extracting details baked inside of fields
+      _compat.py    # python 2/3 compatibility module
+      util.py       # utility / helper functions
+
+    # test suite
     tests/*
 
-    # python 2/3 compatibility module
-    unihan_etl/_compat.py
-
-    # utility / helper functions
-    unihan_etl/util.py
-
 .. _MIT: http://opensource.org/licenses/MIT
 .. _API: http://cihai.readthedocs.org/en/latest/api.html
 .. _UNIHAN: http://www.unicode.org/charts/unihan.html