From 0b4fe40281f447132011a3326847e6b6829d08ac Mon Sep 17 00:00:00 2001 From: Franck Date: Thu, 6 Jun 2019 13:56:47 +0200 Subject: [PATCH] :sparkles: Improve README content --- README.md | 2 +- templates/default.md | 20 +++++++++++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a43b515..939c1c9 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Please ⭐️ this repository if you like it. ## 📜 License -Copyright © 2019 [Franck Abgrall](kefranabg). +Copyright © 2019 [Franck Abgrall](https://github.com/kefranabg). This project is under [license](https://github.com/kefranabg/readme-cli/blob/master/LICENSE). --- diff --git a/templates/default.md b/templates/default.md index 4e67a36..202bba2 100644 --- a/templates/default.md +++ b/templates/default.md @@ -3,6 +3,24 @@ > <%= projectDescription %> <% } -%> + +## 📦 Install + +```sh +npm i +``` + +## 🚀 Usage + +```sh +npm run start +``` + +## ✅ Run tests + +```sh +npm run test +``` <% if (authorName || authorTwitterUsername || authorGithubUsername) { -%> ## 👤 Author @@ -25,7 +43,7 @@ Please ⭐️ this repository if you like it. ## 📜 License <% if (authorName && authorGithubUsername) { -%> -Copyright © <%= currentYear %> [<%= authorName %>](<%= authorGithubUsername %>). +Copyright © <%= currentYear %> [<%= authorName %>](https://github.com/<%= authorGithubUsername %>). <% } -%> This project is under [license](<%= licenseUrl %>). <% } -%>