From beee2475aa42cd83540bac49fb5af26399706edf Mon Sep 17 00:00:00 2001
From: praptisharma28 <123169861+praptisharma28@users.noreply.github.com>
Date: Mon, 15 Jan 2024 01:38:23 +0530
Subject: [PATCH] feature: Readme corrections
---
README.md | 120 ++++++++++++++++++++++++------------------------------
1 file changed, 54 insertions(+), 66 deletions(-)
diff --git a/README.md b/README.md
index 70bb5e0..da7d23a 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,8 @@
-
+[](https://opensource.org/licenses/Apache-2.0)
[](#contributors-)
-
-
-
-
+
---
-
DoodleCollab
@@ -14,94 +10,74 @@
Your Ultimate Whiteboard and Sharing Solution
-
-
-
## What is DoodleCollab ? 🤔
DoodleCollab is a cutting-edge application designed to transform the way we collaborate, offering an unparalleled whiteboard and sharing experience. Developed using the powerful ReactJS framework, our app seamlessly combines intuitive design with advanced functionalities to enhance your collaborative efforts.
-## Willing to help ? 👩🏻💻
-
-*A beginner to Open Source, Web Development ?*
-
-
-This might be the debut repo for you, you can contribute to this repo, solve the issues, raise one and learn more about web as well as get started with Open Source and contributing to projects. Remember, we believe in *Quality*.
-
----
-
-## Hello Contributors 👋🏻
-
----
-
-## Setup Steps
-
-Follow these steps to set up the DoodleCollab app locally:
-
-1. *Clone the repository:*
- bash
- git clone https://github.com/WikiPortal/DoodleCollab.git
-
-
-2. *Navigate to the project directory:*
- bash
- cd DoodleCollab
-
-
-3. *Install dependencies:*
- bash
- npm install
-
-
-4. *If vite is not installed:*
- bash
- npm i vite
- npm install --legacy-peer-deps
-
-
-5. *Start the development server:*
- bash
- npm run start
-
+## Related image (Project under progress) 🚧
-6. *Open your browser and visit [http://localhost:5173](http://localhost:5173)*
+
---
-- *You can also have a look at the [Contributing Guidelines](CONTRIBUTING.md) for proper contributions*
-- *and at the [Setup Guidelines](rules/Setup.md) to setup the react app locally*
-- *also at the [Workflow Guidelines](workflow.md) to see the workflow of the project.*
-
## Technologies used 💻
+
----
+## Willing to help ? 👩🏻💻
-## Related image (Project under progress) 🚧
+*A beginner to Open Source, Web Development ?*
-
+This might be the debut repo for you, you can contribute to this repo, solve the issues, raise one and learn more about web as well as get started with Open Source and contributing to projects. Remember, we believe in *Quality*.
----
+## Setup Steps 🔐
-## 🙏 Support
+Follow these steps to set up the DoodleCollab app locally:
-This project needs a ⭐ from you. Don't forget to leave a star ⭐
+1. **Clone the repository:**
+ ```bash
+ git clone https://github.com/WikiPortal/DoodleCollab.git
+ ```
----
+2. **Navigate to the project directory:**
+ ```bash
+ cd DoodleCollab
+ ```
-## Happy Contributions !!
+3. **Install dependencies:**
+ ```bash
+ npm install
+ ```
+
+4. **If vite is not installed:**
+ ```bash
+ npm i vite
+ npm install --legacy-peer-deps
+ ```
+
+5. **Start the development server:**
+ ```bash
+ npm run start
+ ```
+
+6. **Open your browser and visit [http://localhost:5173](http://localhost:5173):**
+
+
+You can execute these commands one by one in a bash environment.
+- *You can also have a look at the [Contributing Guidelines](CONTRIBUTING.md) for proper contributions*
+- *Have a look at the [Setup Guidelines](rules/Setup.md) to setup the react app locally*
+- *Click here [Workflow Guidelines](workflow.md) to see the workflow of the project.*
----
## Contributors ✨
Thanks goes to these wonderful people:
@@ -132,4 +108,16 @@ Thanks goes to these wonderful people:
-Contributions of any kind are welcome!
\ No newline at end of file
+Contributions of any kind are welcome!🤗
+
+## License 👮
+
+DoodleCollab is Licensed under the Apache License. Please go through the License at least once before contributing.
+
+## Support 🙏
+
+This project needs a ⭐ from you. Don't forget to leave a star ⭐
+
+## Happy Contributions ! 🚀
+
+---
\ No newline at end of file