update/readme

ArunGovil · Dec 15, 2022 · 2b2a9ce · 2b2a9ce · vercel · Dec 15, 2022
1 parent b89ebec
commit 2b2a9ce
Showing 1 changed file with 24 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -4,13 +4,37 @@
 <p align="center">
 one stop directory for frequently used commands.
 </p>
+<h4 align="center"> 
+<a href="https://cmdr.netlify.app/">https://cmdr.netlify.app</a>
+ </h4> 
 
 ---
 
 ## What is cmdr?
 
 cmdr is a directory of frequently used commands in daily software development, categorized across different technologies.
 
+## How do I add a command?
+
+Commands are stored inside the content folder in a JSON file which acts as the current database. You can add new commands by following by following these steps:
+
+- Add it at the end of `content/content.json` file.
+- Submit a PR.
+
+> **Note** Please follow the below format, and make sure you are not creating multiple copies of same command.
+
+```json
+{
+  "title": "<COMMAND TITLE>",
+  "code": "<COMMAND CODE>",
+  "technology": "<CORE TECHNOLOGY>",
+  "tags": [
+    "<TAG ONE>",
+    "<TAG TWO>"
+  ],
+}
+```
+
 ## Running locally
 
 Once the repo is cloned to your local device, you can run:
@@ -22,7 +46,3 @@ yarn dev
 ```
 
 cmdr will start running immediately.
-
-## Contributing
-
-Commands are stored inside the content folder in a JSON file which acts as the current database. You can add new commands to the end of `content/content.json` file and submit a PR.