diff --git a/README.md b/README.md index cf22c95..af438fa 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ downloads - + License: MIT @@ -18,11 +18,11 @@

-> CLI that generates beautiful README.md files.
`readme-md-generator` will suggest you default answers by reading your `package.json` and `git` configuration. +> CLI that generates beautiful README.md files.
`readme-md-generator` will suggest default answers to you by reading your `package.json` and `git` configuration. ## ✨ Demo -`readme-md-generator` is able to read your environment (package.json, git config...) to suggest you default answers during the `README.md` creation process: +`readme-md-generator` is able to read your environment (`package.json`, git config...) to suggest default answers to you during the `README.md` creation process:

demo @@ -34,9 +34,9 @@ Generated `README.md`: cli output

-Example of `package.json` with good meta data: +Example of `package.json` with good metadata: -```json +```json5 // The package.json is not required to run README-MD-GENERATOR { "name": "readme-md-generator", @@ -81,7 +81,7 @@ Use your own `ejs` README template (`-p`): npx readme-md-generator -p path/to/my/own/template.md ``` -You can find [ejs README template examples here](https://github.com/kefranabg/readme-md-generator/tree/master/templates). +You can find ejs README template examples [here](https://github.com/kefranabg/readme-md-generator/tree/master/templates). ## Code Contributors @@ -114,14 +114,14 @@ Support this project with your organization. Your logo will show up here with a Contributions, issues and feature requests are welcome.
Feel free to check [issues page](https://github.com/kefranabg/readme-md-generator/issues) if you want to contribute.
-[Check the contributing guide](./CONTRIBUTING.md).
+[Check the contributing guide](/CONTRIBUTING.md).
## Author 👤 **Franck Abgrall** - Twitter: [@FranckAbgrall](https://twitter.com/FranckAbgrall) -- Github: [@kefranabg](https://github.com/kefranabg) +- GitHub: [@kefranabg](https://github.com/kefranabg) ## Show your support @@ -134,7 +134,7 @@ Please ⭐️ this repository if this project helped you! ## 📝 License Copyright © 2019 [Franck Abgrall](https://github.com/kefranabg).
-This project is [MIT](https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE) licensed. +This project is [MIT](/LICENSE) licensed. ---