Skip to content

Commit

Permalink
add: license and contributing fields
Browse files Browse the repository at this point in the history
  • Loading branch information
Jabolol committed Dec 13, 2023
1 parent 71ae3c2 commit 2f96c28
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# brownie

<img align="right" src="./assets/brownie.png" height="150px" alt="a kawaii brownie" />

# brownie

Add support for **Google Analytics** to your GitHub readme.

## getting started
Expand Down Expand Up @@ -37,15 +37,28 @@ export const config: RouteConfig = {

5. This will make the endpoints `/cocoa` and `/vanilla` available

> [!NOTE]
> It is common practice to make your routes ingredients of your brownie!
> [!NOTE] It is common practice to make your routes ingredients of your brownie!
6. Deploy to [Deno Deploy](https://deno.com/deploy) and fill in the environment variables:
6. Deploy to [Deno Deploy](https://deno.com/deploy) and fill in the environment
variables:

7. Add your freshly baked images to your readme

```
https://[your-deployed-url].deno.dev/cocoa
```

8. The visits will be tracked in your Google Analytics dashboard!
8. The visits will be tracked in your Google Analytics dashboard!

## contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.
Please run the following commands and ensure that there are no errors:

```sh
deno fmt && deno lint
```

## license

This project is licensed under the [MIT license](./LICENSE).

0 comments on commit 2f96c28

Please sign in to comment.