From 75a2e6d4e808ab585c10dc330f9ab2f6c4619411 Mon Sep 17 00:00:00 2001
From: spf13 <steve.francia@gmail.com>
Date: Thu, 11 Jul 2013 22:04:57 -0400
Subject: Now support for config files as yaml, json or toml

---
 README.md | 46 +++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 39 insertions(+), 7 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 555e7fa65..d0f371b5c 100644
--- a/README.md
+++ b/README.md
@@ -102,17 +102,49 @@ The directory structure and templates provide the majority of the
 configuration for a site. In fact a config file isn't even needed for many websites
 since the defaults used follow commonly used patterns.
 
-The following is an example of a config file with the default values
+**Please note the field names must be all lowercase**
 
+### Config Examples
+
+The following is an example of a yaml config file with the default values: 
+    ---
+    sourcedir: "content"
+    layoutdir: "layouts"
+    publishdir: "public"
+    builddrafts: false
+    indexes:
+       category: "categories"
+       tag: "tags"
+    baseurl: "http://yoursite.com/"
+    ...
+
+
+The following is an example of a json config file with the default values: 
     {
-        "SourceDir" : "content",
-        "LayoutDir" : "layouts",
-        "PublishDir" : "public",
-        "BuildDrafts" : false,
-        "Tags" : { "category" : "categories", "tag" : "tags" },
-        "BaseUrl"    : "http://yourSite.com/"
+        "sourcedir": "content",
+        "layoutdir": "layouts",
+        "publishdir": "public",
+        "builddrafts": false,
+        "indexes": {
+           category: "categories",
+           tag: "tags"
+        },
+        "baseurl": "http://yoursite.com/"
     }
 
+
+The following is an example of a toml config file with the default values: 
+
+    sourcedir = "content"
+    layoutdir = "layouts"
+    publishdir = "public"
+    builddrafts = false
+    baseurl = "http://yoursite.com/"
+    [indexes]
+       category = "categories"
+       tag = "tags"
+
+
 ## Usage 
 Make sure either hugo is in your path or provide a path to it.
 
-- 
cgit v1.2.3