docs: updated docs

CONTRIBUTING.md

@@ -12,6 +12,26 @@ possible.
   - `cmd/slack` - Slack notification service.
   - `cmd/telegram` - Telegram notification service
   
+- Documentation
+  `docs` - Contains the documentation in markdown format.
+  - `services.md` If you are adding a new service please add documentaiton to `services.md`.
+  - `home.md` Is the main page rendered when docs website is loaded.
+  - `install.md` Contains the install instructions for different packages.
+
+  - Checking Locally
+    - Docsify is used for documentation rendering from markdown, you can download
+    the cli and test locally before opening a pull request.
+    Install
+    ```bash
+    npm i docsify-cli -g
+    # yarn global add docsify-cli
+    ```
+    Serve locally
+    ```bash
+    docsify serve docs
+    ```
+
+
 ## Commits
 
 Commit messages should be well formatted, and to make that "standardized", we

README.md

@@ -25,7 +25,7 @@
 
 <p align="center">
   <a href="#about">About</a> •
-  <a href="https://kha7iq.github.io/docs-pingme/#/">Documentation</a> •
+  <a href="https://kha7iq.github.io/pingme">Documentation</a> •
   <a href="#supported-services">Supported Services</a> •
   <a href="#install">Install</a> •
   <a href="#github-action">Github Action</a> •
@@ -138,14 +138,14 @@ GLOBAL OPTIONS:
    --help, -h  show help (default: false)
 ```
 
-Check [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details.
+Check [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details.
 
 ## Configuration
 
 All the flags have corresponding environment variables associated with it. You can either provide the value with flags
 or export to a variable.
 
-View the [Documentation Page](https://kha7iq.github.io/docs-pingme/#/) for more details.
+View the [Documentation Page](https://kha7iq.github.io/pingme/#/) for more details.
 
 
 ## Contributing