chore: Updated README.md

README.md

@@ -1,7 +1,51 @@
-## Frappe CRM
+<p align="center">
+  <img src=".github/logo.png" alt="Gameplan logo" height="50" />
+  <p align="center" style="font-weight: bold;">Modern, open-source, CRM solution to supercharge your sales operations.</p>
+</p>
 
-Kick-ass Open Source CRM
+<p align="center">
+    <a href="https://img.shields.io/github/issues/frappe/crm">
+        <img alt="issues" src="https://img.shields.io/github/issues/frappe/crm">
+    </a>
+    <a href="https://img.shields.io/github/license/frappe/crm">
+        <img alt="license" src="https://img.shields.io/github/license/frappe/crm">
+    </a>
+</p>
 
-#### License
+> **Note:** I am currently not expecting any contributions to this repository. But you can always open an issue if you find any bugs, feature requests, or have any suggestions.
 
-AGPLv3
+<img width="1402" alt="Screenshot 2022-09-18 at 9 16 08 PM" src=".github/screenshots/Deal.png">
+
+
+<details>
+  <summary>Show more screenshots</summary>
+
+  <img width="1402" alt="Screenshot 2022-09-18 at 9 18 17 PM" src=".github/screenshots/Leads.png">
+
+  <img width="1402" alt="Screenshot 2022-09-18 at 11 47 06 PM" src=".github/screenshots/Lead.png">
+
+  <img width="1402" alt="Screenshot 2022-09-18 at 9 18 47 PM" src=".github/screenshots/Notes.png">
+
+  <img width="1402" alt="Screenshot 2022-09-18 at 9 18 47 PM" src=".github/screenshots/Call Logs.png">
+</details>
+
+## Getting Started
+
+Currently, this app depends on the `develop` branch of [frappe](https://github.com/frappe/frappe).
+
+1. Setup frappe-bench by following [this guide](https://frappeframework.com/docs/v14/user/en/installation)
+1. In the frappe-bench directory, run `bench start` and keep it running. Open a new terminal session and cd into `frappe-bench` directory.
+1. Run the following commands:
+    ```sh
+    bench new-site crm.test
+    bench get-app crm
+    bench --site crm.test install-app crm
+    bench --site crm.test add-to-hosts
+    bench --site crm.test browse --user Administrator
+    ```
+ 1. Now, open a new terminal session and cd into `frappe-bench/apps/crm`, and run the following commands:
+    ```
+    yarn
+    yarn dev
+    ```
+ 1. Now, you can access the site on vite dev server at `http://crm.test:8080`