diff --git a/README.md b/README.md index 11d433e..7f40426 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,18 @@ ## ✨ 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 : + +demo + +Generated `README.md` : + +cli output + +Example of `package.json` with good meta data : + ```json -// My project package.json (NOT REQUIRED TO RUN README-MD-GENERATOR) +// The package.json is not required to run README-MD-GENERATOR { "name": "readme-md-generator", "version": "0.1.3", @@ -46,14 +56,6 @@ } ``` -`readme-md-generator` will process as following within a `git` repository that contains a `package.json` config like the one above : - -demo - -Generated `README.md` : - -cli output - ## 📦 Install With npm :