Skip to content

Commit

Permalink
add: project readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Jabolol committed Dec 13, 2023
1 parent dda0051 commit 71ae3c2
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# brownie

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

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

## getting started

1. Install deno if you haven't already:

```sh
curl -fsSL https://deno.land/x/install/install.sh | sh
```

2. Clone the repo:

```sh
git clone git@github.com:Jabolol/brownie.git .
```

3. Fill in the [`.env`](./.env.example) file:

```sh
cp .env.example .env && vim .env
```

4. Edit the [`config.ts`](./config.ts) file to add your images:

```ts
export const config: RouteConfig = {
routes: {
cocoa: "https://my-stats.dev/contribs",
vanilla: "https://my-stats.dev/issues",
},
};
```

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

> [!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:

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!
Binary file added assets/brownie.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 71ae3c2

Please sign in to comment.