From 45606e9f85a982bf83de246ffb3e77aa892602f8 Mon Sep 17 00:00:00 2001
From: Aravinth Manivannan <realaravinth@batsense.net>
Date: Wed, 10 Jan 2024 02:06:48 +0530
Subject: [PATCH] feat: basic README

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..277550e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+[![status-badge](https://ci.batsense.net/api/badges/110/status.svg)](https://ci.batsense.net/repos/110)
+
+---
+
+# [Playwright](https://playwright.dev/) based integration testing for [Forgejo](https://forgejo.org)
+
+## Development
+
+## Dependencies
+
+-   Node v20.10.0: We use [`nvm`](https://github.com/nvm-sh/nvm) for Node version management. If installed, run `nvm use` in repo directory
+-   Docker compose: for spinning up test environment
+
+## Usage
+
+Please install development dependencies. Also consider installing
+browser drivers (see
+[here](https://playwright.dev/docs/intro#installing-playwright)). On my
+development, I test only on Firefox and Chromium, so I run:
+
+```bash
+npx playwright test --project=firefox \
+	&& npx playwright test --project=chromium
+```