Init readme file

mobizel · Sep 28, 2020 · 4576dee · 4576dee
1 parent 0e61b5e
commit 4576dee
Showing 1 changed file with 22 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,22 @@
-# markdown-docs-bundle
+# mobizel/markdown-docs-bundle
+
+## Setup
+```bash
+composer require mobizel/markdown-docs-bundle
+```
+
+```yaml
+# config/routes/mobizel_markdown_docs.yaml
+
+_mobizel_markdowns:
+    resource: '@MobizelMarkdownDocsBundle/Resources/config/routes.xml'
+
+```
+
+## Write your own doc 
+Markdown templates are on `docs` directory.
+
+Your files are already available on your server.
+
+Example:
+`docs/dummy/foo.md` is available at [/docs/dummy/foo](http://localhost:8000/docs/dummy/foo)