diff --git a/README.md b/README.md index 64e14da..8c47654 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,50 @@ + + + + + + + + + + + + + + + + # bloggify-flexible-router [![Version](https://img.shields.io/npm/v/bloggify-flexible-router.svg)](https://www.npmjs.com/package/bloggify-flexible-router) [![Downloads](https://img.shields.io/npm/dt/bloggify-flexible-router.svg)](https://www.npmjs.com/package/bloggify-flexible-router) + + + + + + > A flexible router for Bloggify apps. + + + + + + + + + + + + + + + + ## :cloud: Installation ```sh @@ -20,6 +58,37 @@ yarn add bloggify-flexible-router + + + + + + + + + + + + + + + + + + +## :question: Get Help + +There are few ways to get help: + + + + 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question. + 2. For bug reports and feature requests, open issues. :bug: + + + + + ## :memo: Documentation @@ -71,16 +140,60 @@ exports.post = ctx => ... + + + + + + + + + + + ## :yum: How to contribute Have an idea? Found a bug? See [how to contribute][contributing]. + + + + + + + + + + + + + +## :dizzy: Where is this library used? +If you are using this library in one of your projects, add it in this list. :sparkles: + + - `bloggify` + + + + + + + + + + + ## :scroll: License [MIT][license] © [Bloggify][website] -[license]: http://showalicense.com/?fullname=Bloggify%20%3Csupport%40bloggify.org%3E%20(https%3A%2F%2Fbloggify.org)&year=2017#license-mit + + + + + +[license]: /LICENSE [website]: https://bloggify.org [contributing]: /CONTRIBUTING.md [docs]: /DOCUMENTATION.md diff --git a/package-lock.json b/package-lock.json index 1613adf..1b184fd 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "bloggify-flexible-router", - "version": "2.0.5", + "version": "2.0.6", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index b87518e..a6b3bf2 100644 --- a/package.json +++ b/package.json @@ -51,4 +51,4 @@ "error_pages": {} } } -} \ No newline at end of file +}