From 53a21b7c4ad95e4d1c37979bd6166e4528d7d114 Mon Sep 17 00:00:00 2001
From: Aravinth Manivannan <realaravinth@batsense.net>
Date: Mon, 18 Sep 2023 20:44:08 +0530
Subject: [PATCH] feat: basic docs

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index f35cbc2..c87c38c 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,35 @@ for more information.
 NOTE: The test [forgejo configuration](./integration/conf/app.ini) may
 be insecure for your usecase since it allows CORS for all origins with
 the widest possible surface.
+
+## Build
+
+```bash
+pnpm install
+pnpm run build
+```
+Compiled library will be available at `./dist/index.js`
+
+## Docs
+
+```bash
+pnpm install
+pnpm run doc
+firefox ./docs/index.html
+```
+
+## Tests
+
+There are [scripts][./integration] to setup a Forgejo instance locally,
+create [bunch of]./integration/lib.sh) of users, repository and issues
+to test all functionality offered by this library. It might be useful to
+recreate this environment with `make env.up and ./integration/tests.sh`
+for development.
+
+Uses Docker.
+
+```bash
+pnpm install
+make env.up
+make test
+```