feat: add build status badge and docs link
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed

This commit is contained in:
Aravinth Manivannan 2023-09-19 02:07:19 +05:30
parent 92384490dc
commit 5353cf531a
Signed by: realaravinth
GPG key ID: F8F50389936984FF

View file

@ -1,3 +1,9 @@
[![status-badge](https://ci.batsense.net/api/badges/85/status.svg)](https://ci.batsense.net/repos/85)
---
## Dev Notes
Requires your Forgejo instance admin to enable CORS for at least the Requires your Forgejo instance admin to enable CORS for at least the
origin which serves the notification panel. Please see origin which serves the notification panel. Please see
[here](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#cors-cors) [here](https://forgejo.org/docs/latest/admin/config-cheat-sheet/#cors-cors)
@ -13,10 +19,13 @@ the widest possible surface.
pnpm install pnpm install
pnpm run build pnpm run build
``` ```
Compiled library will be available at `./dist/index.js` Compiled library will be available at `./dist/index.js`
## Docs ## Docs
https://forgejo-notifications-core.docs.forgeflux.org
```bash ```bash
pnpm install pnpm install
pnpm run doc pnpm run doc