Changes to docs structure to help navigation on GitHub

tzi · May 24, 2014 · 481cd70 · 481cd70
1 parent 55ac0ee
commit 481cd70
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 16 deletions.
diff --git a/docs/contributing/index.md → docs/contributing/readme.md b/docs/contributing/index.md → docs/contributing/readme.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/installation/index.md → docs/installation/readme.md b/docs/installation/index.md → docs/installation/readme.md
diff --git a/docs/metrics/index.md → docs/metrics/readme.md b/docs/metrics/index.md → docs/metrics/readme.md
diff --git a/docs/readme.md b/docs/readme.md
@@ -0,0 +1,16 @@
+# Parker
+Parker is a stylesheet analysis tool. It runs metrics on your stylesheets and will report on their complexity.
+
+## Table of Contents
+
+1. [Installation](installation/readme.md)
+    1. [Installing Node.JS](installation/readme.md#install-node-js)
+    2. [Installing Parker](installation/readme.md#install-parker)
+2. [Usage](usage/readme.md)
+	1. [Options](usage/readme.md#options)
+3. [Metrics](metrics/readme.md)
+	1. [Bundled Metrics](metrics/readme.md#bundled-metrics)
+	2. [Authoring Metrics](metrics/readme.md#authoring-metrics)
+4. [Contributing](contributing/readme.md)
+	1. [GitHub](contributing/readme.md#github)
+	2. [Testing](contributing/readme.md#testing)
diff --git a/docs/usage/index.md → docs/usage/readme.md b/docs/usage/index.md → docs/usage/readme.md