docs: updated readme

Author: harshkhandeparkar

README.md

@@ -16,21 +16,19 @@
 
 <!-- PROJECT LOGO -->
 <br />
-<!-- UPDATE -->
 <div align="center">
-  <a href="https://github.com/metakgp/PROJECT_NAME">
-    <img width="140" alt="image" src="https://user-images.githubusercontent.com/86282911/206632284-cb260f57-c612-4ab5-b92b-2172c341ab23.png">
+  <a href="https://github.com/metakgp/odins-vault">
+    <img width="140" alt="image" src="https://raw.githubusercontent.com/metakgp/design/main/logos/black-large.jpg">
   </a>
 
-  <h3 align="center">PROJECT_NAME</h3>
+  <h3 align="center">Odin's Vault</h3>
 
   <p align="center">
-  <!-- UPDATE -->
-    <i>Project one liner slogan goes here</i>
+    <i>Open sourcing Odin's treasures</i>
     <br />
-    <a href="https://github.com/metakgp/PROJECT_NAME/issues">Report Bug</a>
+    <a href="https://github.com/metakgp/odins-vault/issues">Report Bug</a>
     ·
-    <a href="https://github.com/metakgp/PROJECT_NAME/issues">Request Feature</a>
+    <a href="https://github.com/metakgp/odins-vault/issues">Request Feature</a>
   </p>
 </div>
 
@@ -40,9 +38,7 @@
 <summary>Table of Contents</summary>
 
 - [About The Project](#about-the-project)
-  - [Supports](#supports)
 - [Getting Started](#getting-started)
-  - [Prerequisites](#prerequisites)
   - [Installation](#installation)
 - [Usage](#usage)
 - [Maintainer(s)](#maintainers)
@@ -54,81 +50,23 @@
 
 <!-- ABOUT THE PROJECT -->
 ## About The Project
-<!-- UPDATE -->
-<div align="center">
-  <a href="https://github.com/metakgp/PROJECT_NAME">
-    <img width="80%" alt="image" src="https://user-images.githubusercontent.com/86282911/206632547-a3b34b47-e7ae-4186-a1e6-ecda7ddb38e6.png">
-  </a>
-</div>
-
-_Detailed explaination of the project goes here_
-
-<p align="right">(<a href="#top">back to top</a>)</p>
-
-<div id="supports"></div>
-
-### Supports:
-<!-- UPDATE -->
-1. Shells
-    * `bash`
-    * `zsh`
-2. OS(s)
-    * any `*nix`[`GNU+Linux` and `Unix`]
+[WIP]
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 ## Getting Started
-
-To set up a local instance of the application, follow the steps below.
-
-### Prerequisites
-The following dependencies are required to be installed for the project to function properly:
-<!-- UPDATE -->
-* npm
-  ```sh
-  npm install npm@latest -g
-  ```
-
-<p align="right">(<a href="#top">back to top</a>)</p>
-
 ### Installation
-
-_Now that the environment has been set up and configured to properly compile and run the project, the next step is to install and configure the project locally on your system._
-<!-- UPDATE -->
-1. Clone the repository
-   ```sh
-   git clone https://github.com/metakgp/PROJECT_NAME.git
-   ```
-2. Make the script executable
-   ```sh
-   cd ./PROJECT_NAME
-   chmod +x ./PROJECT_NAME
-   ```
-3. Execute the script
-   ```sh
-   ./PROJECT_NAME
-   ```
+[WIP]
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 
 <!-- USAGE EXAMPLES -->
 ## Usage
-<!-- UPDATE -->
-Use this space to show useful examples of how this project can be used. Additional screenshots, code examples and demos work well in this space.
-
-<div align="center">
-  <a href="https://github.com/metakgp/PROJECT_NAME">
-    <img width="80%" alt="image" src="https://user-images.githubusercontent.com/86282911/206632640-40dc440e-5ef3-4893-be48-618f2bd85f37.png">
-  </a>
-</div>
-
-<p align="right">(<a href="#top">back to top</a>)</p>
+[WIP]
 
 ## Maintainer(s)
-
-<!-- UPDATE -->
-- [NAME](https://github.com/GITHUB_USERNAME)
+- [Harsh Khandeparkar](https://github.com/GITHUB_USERNAME)
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -169,16 +107,16 @@ Use this space to show useful examples of how this project can be used. Addition
 
 <!-- MARKDOWN LINKS & IMAGES -->
 
-[contributors-shield]: https://img.shields.io/github/contributors/metakgp/PROJECT_NAME.svg?style=for-the-badge
-[contributors-url]: https://github.com/metakgp/PROJECT_NAME/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/metakgp/PROJECT_NAME.svg?style=for-the-badge
-[forks-url]: https://github.com/metakgp/PROJECT_NAME/network/members
-[stars-shield]: https://img.shields.io/github/stars/metakgp/PROJECT_NAME.svg?style=for-the-badge
-[stars-url]: https://github.com/metakgp/PROJECT_NAME/stargazers
-[issues-shield]: https://img.shields.io/github/issues/metakgp/PROJECT_NAME.svg?style=for-the-badge
-[issues-url]: https://github.com/metakgp/PROJECT_NAME/issues
-[license-shield]: https://img.shields.io/github/license/metakgp/PROJECT_NAME.svg?style=for-the-badge
-[license-url]: https://github.com/metakgp/PROJECT_NAME/blob/master/LICENSE
+[contributors-shield]: https://img.shields.io/github/contributors/metakgp/odins-vault.svg?style=for-the-badge
+[contributors-url]: https://github.com/metakgp/odins-vault/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/metakgp/odins-vault.svg?style=for-the-badge
+[forks-url]: https://github.com/metakgp/odins-vault/network/members
+[stars-shield]: https://img.shields.io/github/stars/metakgp/odins-vault.svg?style=for-the-badge
+[stars-url]: https://github.com/metakgp/odins-vault/stargazers
+[issues-shield]: https://img.shields.io/github/issues/metakgp/odins-vault.svg?style=for-the-badge
+[issues-url]: https://github.com/metakgp/odins-vault/issues
+[license-shield]: https://img.shields.io/github/license/metakgp/odins-vault.svg?style=for-the-badge
+[license-url]: https://github.com/metakgp/odins-vault/blob/master/LICENSE
 [wiki-shield]: https://custom-icon-badges.demolab.com/badge/metakgp_wiki-grey?logo=metakgp_logo&style=for-the-badge
 [wiki-url]: https://wiki.metakgp.org
 [slack-shield]: https://img.shields.io/badge/-MetaKGP%20Slack-%234a154b?style=for-the-badge&logo=slack