Improved docs

akyoto · May 6, 2019 · effdb8a · effdb8a
1 parent 36d4c30
commit effdb8a
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,32 @@ readme
 
 Generates `README.md` files for every subdirectory that has a `README.src.md` file.
 
+## Snippets
+
+```text
+name
+```
+
+Repository name.
+
+```text
+go:header
+```
+
+Header for Go projects.
+
+```text
+go:footer
+```
+
+Footer for Go projects.
+
+```text
+go:install
+```
+
+Installation instructions for Go projects.
+
 ## Patrons
 
 | [![Scott Rayapoullé](https://avatars3.githubusercontent.com/u/11772084?s=70&v=4)](https://github.com/soulcramer) |
@@ -45,4 +71,4 @@ Want to see [your own name here](https://www.patreon.com/eduardurbach)?
 [coverage-image]: https://codecov.io/gh/akyoto/readme/graph/badge.svg
 [coverage-url]: https://codecov.io/gh/akyoto/readme
 [patreon-image]: https://img.shields.io/badge/patreon-donate-green.svg
-[patreon-url]: https://www.patreon.com/eduardurbach
+[patreon-url]: https://www.patreon.com/eduardurbach
diff --git a/README.src.md b/README.src.md
@@ -14,4 +14,30 @@ readme
 
 Generates `README.md` files for every subdirectory that has a `README.src.md` file.
 
-{go:footer}
+## Snippets
+
+```text
+name
+```
+
+Repository name.
+
+```text
+go:header
+```
+
+Header for Go projects.
+
+```text
+go:footer
+```
+
+Footer for Go projects.
+
+```text
+go:install
+```
+
+Installation instructions for Go projects.
+
+{go:footer}