From 9ea7f70b50ee0c27320b2f66670edf646bd77114 Mon Sep 17 00:00:00 2001 From: Anush Date: Mon, 17 Apr 2023 22:41:34 +0530 Subject: [PATCH 1/5] docs: Updated the README.md --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/README.md b/README.md index 1e2d8ed3..3c1d386c 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,57 @@ Open Sauced

🍕 Open Sauced Browser Extension(s) 🍕

+

+ GitHub code size in bytes + GitHub commit activity + + GitHub issues + + + Discord + + + Twitter + +

+ +## Running the project locally + +In order to run the project we need the following software binaries installed on our development machines: + +- [Node.js](https://nodejs.org/en) +- [NPM](https://www.npmjs.com/) + +To install the project dependencies: + +```shell +npm ci +``` + +To run a local instance of the project: + +```shell +npm run dev +``` + +## Installing the extension on a Chromium based browser: +After running the above commands, +1. Navigate to `chrome://extensions`. +2. Enable the `Developer Mode`. +3. Select `Load Extension` and choose the generated `dist` directory from the project folder to install it. + +You should now have the extension installed and running. + +## 🤝 Contributing + +We encourage you to contribute to OpenSauced! Please check out the [Contributing guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) for guidelines about how to proceed. + +We have a commit utility called [@open-sauced/conventional-commit](https://github.com/open-sauced/conventional-commit) that helps you write your commits in a way that is easy to understand and process by others. + +## 🍕 Community + +Got Questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P). +Find Open Sauced videos and release overviews on our [YouTube Channel](https://www.youtube.com/channel/UCklWxKrTti61ZCROE1e5-MQ). ## ⚖️ LICENSE From 4af751683b46e61815237795b5bd33b7b027b28c Mon Sep 17 00:00:00 2001 From: Anush Date: Mon, 17 Apr 2023 22:53:39 +0530 Subject: [PATCH 2/5] docs: updated the core team info --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 3c1d386c..5e797be6 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,11 @@ After running the above commands, You should now have the extension installed and running. +## 🙌🏼 Core Team +* [Brian Douglas](https://github.com/bdougie) +* [Divyansh Singh](https://github.com/diivi) +* [Anush Shetty](https://github.com/Anush008") + ## 🤝 Contributing We encourage you to contribute to OpenSauced! Please check out the [Contributing guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) for guidelines about how to proceed. From 1d5ae2b33b2bc472c9efbd92650cc7e110f04103 Mon Sep 17 00:00:00 2001 From: Anush Date: Mon, 17 Apr 2023 23:00:30 +0530 Subject: [PATCH 3/5] docs: Rephrased installation instructions --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e797be6..1d3acba9 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,12 @@

+## Goals +To enable developers find + ## Running the project locally -In order to run the project we need the following software binaries installed on our development machines: +To run the project, you'll need the following software binaries installed on your development machines: - [Node.js](https://nodejs.org/en) - [NPM](https://www.npmjs.com/) From 664ccc7d63af048e435ec5ff8ca5ed84beb58f05 Mon Sep 17 00:00:00 2001 From: Anush Date: Mon, 17 Apr 2023 23:02:32 +0530 Subject: [PATCH 4/5] docs: Objectives to be added after discussions --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 1d3acba9..604605be 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,6 @@

-## Goals -To enable developers find - ## Running the project locally To run the project, you'll need the following software binaries installed on your development machines: From 0a4993a37108618b98ef54a816a09aa8e57e19b3 Mon Sep 17 00:00:00 2001 From: Anush Date: Mon, 17 Apr 2023 23:48:42 +0530 Subject: [PATCH 5/5] docs: Added Avatars to the core team section --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 604605be..f577bc6e 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,18 @@ After running the above commands, You should now have the extension installed and running. ## 🙌🏼 Core Team -* [Brian Douglas](https://github.com/bdougie) -* [Divyansh Singh](https://github.com/diivi) -* [Anush Shetty](https://github.com/Anush008") +

+ + Brian Douglas + + + Divyansh Singh + + + Anush Shetty + +

## 🤝 Contributing