chore(readme): 📝 update readme and add @mcnaveen to all-contributors

mcnaveen · Aug 3, 2022 · 09e50ba · 09e50ba
1 parent 870d71b
commit 09e50ba
Show file tree

Hide file tree

Showing 4 changed files with 329 additions and 15 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -5,6 +5,22 @@
   "imageSize": 100,
   "commit": false,
   "contributors": [
+    {
+      "login": "mcnaveen",
+      "name": "MC Naveen",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8493007?v=4",
+      "profile": "https://github.com/mcnaveen",
+      "contributions": [
+        "bug",
+        "code",
+        "data",
+        "doc",
+        "example",
+        "ideas",
+        "maintenance",
+        "review"
+      ]
+    },
     {
       "login": "jonah-butler",
       "name": "jonah-butler",
@@ -35,5 +51,6 @@
   "projectOwner": "mcnaveen",
   "repoType": "github",
   "repoHost": "https://github.com",
-  "skipCi": true
+  "skipCi": true,
+  "commitConvention": "none"
 }
diff --git a/README.md b/README.md
@@ -1,9 +1,7 @@
 # Random Words API
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-
-[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
-
+[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 ![build-test](https://github.com/mcnaveen/Random-Words-API/workflows/build-test/badge.svg)
@@ -22,14 +20,27 @@
 
 - Base URL: `https://random-words-api.vercel.app/word`
 
-```html
-- /noun - /sentence - /question - /adjective - /idiom - /verb - /letter -
-/paragraph - /vocabulary - /1-word-quotes - /2-word-quotes - /3-word-quotes -
-/affirmation
+```text
+- /noun
+- /sentence
+- /question
+- /adjective
+- /idiom
+- /verb
+- /letter
+- /paragraph
+- /vocabulary
+- /1-word-quotes
+- /2-word-quotes
+- /3-word-quotes
+- /affirmation
 ```
 
 ## 🌐 Sample API Response
 
+API: `https://random-words-api.vercel.app/word/`
+Method: `GET`
+
 ```json
 [
   {
@@ -42,6 +53,9 @@
 
 ## 🌐 Sample Dutch Response
 
+API: `https://random-words-api.vercel.app/word/dutch`
+Method: `GET`
+
 ```json
 [
   {
@@ -54,6 +68,9 @@
 
 ## 🌐 Sample Pronunciation Request
 
+API: `https://random-words-api.vercel.app/pronounce`
+Method: `POST`
+
 ```sh
 POST http://localhost:3000/pronounce
 Content-Type: application/json
@@ -113,7 +130,11 @@ OR
 Project - Give Forked Repo URL - Go Live
 ```
 
-## ✍️ Commit
+## :question: How to Contribute?
+
+Make your changes and follow the below instructions. We follow conventional commits.
+
+### ✍️ Commit
 
 - Stage all changes
 
@@ -158,6 +179,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
+    <td align="center"><a href="https://github.com/mcnaveen"><img src="https://avatars.githubusercontent.com/u/8493007?v=4?s=100" width="100px;" alt=""/><br /><sub><b>MC Naveen</b></sub></a><br /><a href="https://github.com/mcnaveen/Random-Words-API/issues?q=author%3Amcnaveen" title="Bug reports">🐛</a> <a href="https://github.com/mcnaveen/Random-Words-API/commits?author=mcnaveen" title="Code">💻</a> <a href="#data-mcnaveen" title="Data">🔣</a> <a href="https://github.com/mcnaveen/Random-Words-API/commits?author=mcnaveen" title="Documentation">📖</a> <a href="#example-mcnaveen" title="Examples">💡</a> <a href="#ideas-mcnaveen" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-mcnaveen" title="Maintenance">🚧</a> <a href="https://github.com/mcnaveen/Random-Words-API/pulls?q=is%3Apr+reviewed-by%3Amcnaveen" title="Reviewed Pull Requests">👀</a></td>
     <td align="center"><a href="https://github.com/jonah-butler"><img src="https://avatars.githubusercontent.com/u/18040568?v=4?s=100" width="100px;" alt=""/><br /><sub><b>jonah-butler</b></sub></a><br /><a href="https://github.com/mcnaveen/Random-Words-API/commits?author=jonah-butler" title="Code">💻</a> <a href="https://github.com/mcnaveen/Random-Words-API/commits?author=jonah-butler" title="Documentation">📖</a></td>
     <td align="center"><a href="https://santhoshveer.com/"><img src="https://avatars.githubusercontent.com/u/10300271?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Santhosh Veer</b></sub></a><br /><a href="https://github.com/mcnaveen/Random-Words-API/commits?author=mskian" title="Code">💻</a> <a href="https://github.com/mcnaveen/Random-Words-API/commits?author=mskian" title="Documentation">📖</a> <a href="#ideas-mskian" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-mskian" title="Maintenance">🚧</a> <a href="https://github.com/mcnaveen/Random-Words-API/issues?q=author%3Amskian" title="Bug reports">🐛</a> <a href="https://github.com/mcnaveen/Random-Words-API/pulls?q=is%3Apr+reviewed-by%3Amskian" title="Reviewed Pull Requests">👀</a></td>
   </tr>

diff --git a/package.json b/package.json
@@ -17,7 +17,9 @@
 		"start": "node index.js",
 		"action": "node ./test/test.js",
 		"dev": "nodemon index.js --ext '*'",
-		"commit": "gacp"
+		"commit": "gacp",
+		"contributors:add": "all-contributors add",
+		"contributors:generate": "all-contributors generate"
 	},
 	"type": "module",
 	"keywords": [
@@ -37,6 +39,7 @@
 	"author": "MC Naveen",
 	"license": "MIT",
 	"devDependencies": {
+		"all-contributors-cli": "^6.20.0",
 		"gacp": "^3.0.2",
 		"nodemon": "^2.0.19"
 	},