-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.