Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
berrysauce authored Oct 9, 2023
1 parent cda42bb commit 0f7f12b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ As you can also see, this JSON file mentions a path to an icon, which is used to

Ingredients has an API you can use. This API can be used to scan sites.

> **Note**: The API has a set of CORS origins in place as of now, so might only work locally! This might change later.
> [!NOTE]
> The API has a set of CORS origins in place as of now, so might only work locally! This might change later.
You can start a scan with one `GET` call. Just provide the URL you want to scan as a query parameter.

Expand All @@ -78,6 +79,7 @@ GET https://ingredients.tech/api/ingredients?url=https://example.com

## ⚙️ How to add Ingredients

> [!NOTE]
> Before you contribute, please take a look at the [CONTRIBUTING.md](https://github.com/berrysauce/ingredients/blob/main/CONTRIBUTING.md) file
To add an ingredient, create a JSON file in [ingredients/](https://github.com/berrysauce/ingredients/tree/main/ingredients) folder inside a fitting category-folder and add its icon (size 32x32 pixels, `.png` format) in the [icons/](https://github.com/berrysauce/ingredients/tree/main/icons) folder.
Expand Down

0 comments on commit 0f7f12b

Please sign in to comment.