Readme, version, license

2024-09-05 13:32:39 +02:00
parent 6d1a320445
commit 1978cb6955
3 changed files with 31 additions and 4 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,23 @@
+# Kredits Reviews
+
+This repository contains a script to create Kosmos Kredits for PR reviews on GitHub and Gitea.
+
+## Installation
+
+### Install dependencies
+
+    $ npm install
+
+### Set up environment variables
+
+    $ cp .env.example .env
+
+Edit the `.env` file and add API tokens for GitHub and Gitea.
+
+## Usage
+
+Run
+
+    $ node index.js
+
+to get usage instructions.