Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updated the README.md #15

Merged
merged 5 commits into from
Apr 18, 2023
Merged

docs: Updated the README.md #15

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9ea7f70
docs: Updated the README.md
Anush008 Apr 17, 2023
4af7516
docs: updated the core team info
Anush008 Apr 17, 2023
1d5ae2b
docs: Rephrased installation instructions
Anush008 Apr 17, 2023
664ccc7
docs: Objectives to be added after discussions
Anush008 Apr 17, 2023
0a4993a
docs: Added Avatars to the core team section
Anush008 Apr 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,62 @@
<img alt="Open Sauced" src="https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png" width="300px">
<h1>🍕 Open Sauced Browser Extension(s) 🍕</h1>
Anush008 marked this conversation as resolved.
Show resolved Hide resolved
</div>
<p align="center">
<img src="https://img.shields.io/github/languages/code-size/open-sauced/browser-extensions" alt="GitHub code size in bytes">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

<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

In order to run the project we need the following software binaries installed on our development machines:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of "we", using "you" would be better, as we already do in other docs.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me rephrase that.


- [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
* [Brian Douglas](https://github.com/bdougie)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think maybe something like this would look better - https://github.com/openfoodfacts/taxonomy-editor#contributors?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's great. They are using contrib.rocks to generate the contributors collage. Let me see if I can do something like that.

Copy link
Member Author

@Anush008 Anush008 Apr 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot_20230417-234952_Brave

* [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.

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