Skip to content

Commit

Permalink
docs: Updated the README.md (#15)
Browse files Browse the repository at this point in the history
* docs: Updated the README.md

* docs: updated the core team info

* docs: Rephrased installation instructions

* docs: Objectives to be added after discussions

* docs: Added Avatars to the core team section
  • Loading branch information
Anush008 authored Apr 18, 2023
1 parent a447551 commit 3e4dd69
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,71 @@
<img alt="Open Sauced" src="https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png" width="300px">
<h1>🍕 Open Sauced Browser Extension(s) 🍕</h1>
</div>
<p align="center">
<img src="https://img.shields.io/github/languages/code-size/open-sauced/browser-extensions" alt="GitHub code size in bytes">
<img src="https://img.shields.io/github/commit-activity/w/open-sauced/browser-extensions" alt="GitHub commit activity">
<a href="https://github.com/open-sauced/browser-extensions/issues">
<img src="https://img.shields.io/github/issues/open-sauced/browser-extensions" alt="GitHub issues">
</a>
<a href="https://discord.gg/U2peSNf23P">
<img src="https://img.shields.io/discord/714698561081704529.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2" alt="Discord">
</a>
<a href="https://twitter.com/saucedopen">
<img src="https://img.shields.io/twitter/follow/saucedopen?label=Follow&style=social" alt="Twitter">
</a>
</p>

## Running the project locally

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/)

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.

## 🙌🏼 Core Team
<p align="left>
<a href="https://github.com"/></a>
<a href="https://github.com/bdougie">
<img src="https://images.weserv.nl/?url=avatars.githubusercontent.com/u/5713670&h=60&w=60&fit=cover&mask=circle" alt="Brian Douglas">
</a>
<a href="https://github.com/diivi">
<img src="https://images.weserv.nl/?url=avatars.githubusercontent.com/u/41837037&h=60&w=60&fit=cover&mask=circle" alt="Divyansh Singh">
</a>
<a href="https://github.com/Anush008">
<img src="https://images.weserv.nl/?url=avatars.githubusercontent.com/u/46051506&h=60&w=60&fit=cover&mask=circle" alt="Anush Shetty">
</a>
</p>

## 🤝 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

Expand Down

0 comments on commit 3e4dd69

Please sign in to comment.