Merge branch 'master' of github.com:seanlane/gochowdown

5 files changed, 16 insertions, 12 deletions

diff --git a/README.md b/README.md
index 4c31ea3..4d083f5 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,30 @@
+# GoChowdown
+
 A theme for [Hugo](https://gohugo.io/) based on the [Chowdown](https://github.com/clarklab/chowdown) theme for Jekyll
 
+<p align="center">
+  <img src="https://raw.githubusercontent.com/seanlane/gochowdown/master/images/screenshot.png" />
+</p>
+
 ## Quick Start
 
 1. Add the repository into your Hugo Project repository as a submodule, `git submodule add https://github.com/seanlane/gochowdown.git themes/gochowdown`.
 2. Configure your `config.toml` or `config.yaml`.
 3. Build your site with `hugo serve` and see the result at `http://localhost:1313/`.
 
-## Add a new recipe draft
+## Using this theme
+
+Similarly to how the original Chowdown theme for Jekyll was organized, this theme adds two sections, recipes and components. The primary section you'll want to use is the recipes, as they form the panel listing on the front page, as well as most of the content. The components section is for recipes that form subcomponents of a recipe, allowing for a recipe to call on several components, and different recipes to reuse the same component, if desired.
+
+Note that this is a work in progress, so things may be broken or change in the future. Feel free to contribute or offer suggestions.
+
+### Add a new recipe draft
 
 1. Navigate to the root directory of your website folder within a terminal
 2. Type `hugo new --kind recipe-bundle recipes/name-of-your-new-recipe-here`, replacing `name-of-your-new-recipe-here` with the name of your recipe
   - Note that the default template (archetype in Hugo vernacular) will replace the hypens in the provided name with spaces as the title and capitalize the first letter of each word. For example, if I were to enter the command `hugo new --kind recipe-bundle recipes/hot-dog`, I would find a new folder at `content/recipes/hot-dog`, and the title within the `index.md` file in that folder would be `Hot Dog`.
 
-## Add a new recipe with components
+### Add a new recipe with components
 
 Similar to above, but instead of adding the recipes to the `content/recipes` directory, add the individual components to the `content/components` directory. Then add a new recipe as you normally would, and replace the instructions list with a components list, using the title (aka name) of the recipe, and modify the directions section as needed.
 
diff --git a/images/.gitkeep b/images/.gitkeep
deleted file mode 100644
index e69de29..0000000
--- a/images/.gitkeep
+++ /dev/null
diff --git a/images/screenshot.png b/images/screenshot.png
new file mode 100644
index 0000000..dfaec34
--- /dev/null
+++ b/images/screenshot.png
diff --git a/images/tn.png b/images/tn.png
new file mode 100644
index 0000000..31af5e4
--- /dev/null
+++ b/images/tn.png
diff --git a/theme.toml b/theme.toml
index 36e3f09..c2c77e0 100644
--- a/theme.toml
+++ b/theme.toml
@@ -3,16 +3,8 @@ license = "MIT"
 licenselink = "https://github.com/seanlane/gochowdown/blob/master/LICENSE.md"
 description = "A recipe theme for Hugo based on the Chowdown Jekyll theme"
 homepage = "https://github.com/seanlane/gochowdown"
-tags = [
-  "recipes",
-  "responsive",
-  "simple",
-  "clean"
-]
-features = [
-  "analytics",
-  "favicon"
-]
+tags = ["recipes", "cooking", "responsive", "clean"]
+features = ["analytics", "favicon"]
 min_version = "0.49"
 
 [author]