Add information about snippets

blakeembrey · Oct 3, 2014 · 062c29a · 062c29a
1 parent 2de3722
commit 062c29a
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,17 @@ metalsmith.use(snippet({
 }));
 ```
 
+### Templates
+
+The module adds a `snippet` property to the metadata of every file, if it hasn't already been defined. This allows you to define a custom snippet inline when you want to provide something more advanced than the autogenerated snippet.
+
+```
+---
+title: Example Article
+snippet: This is a snippet about my article.
+---
+```
+
 ## License
 
 MIT