diff --git a/README.md b/README.md new file mode 100644 index 0000000..f024020 --- /dev/null +++ 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. diff --git a/index.js b/index.js index 7aea842..951acc0 100644 --- a/index.js +++ b/index.js @@ -184,7 +184,6 @@ Promise.all([ const kredits = values[0]; const reviews = values[1]; - generateContributionData(reviews, kredits.Contributor).then( (contributionData) => { if (argv.dry) { diff --git a/package.json b/package.json index 1de1f1a..0d73a6c 100644 --- a/package.json +++ b/package.json @@ -1,18 +1,23 @@ { "name": "kredits-reviews", - "version": "1.0.0", + "version": "0.5.0", "description": "Create Kosmos Kredits contributions for code reviews", "main": "index.js", "scripts": { + "start": "node index.js", "test": "echo \"Error: no test specified\" && exit 1" }, "author": "Garret Alfert", - "license": "ISC", + "license": "MIT", "dependencies": { "axios": "^0.21.1", "dotenv": "^8.2.0", "ethers": "^5.0.24", "kredits-contracts": "^6.0.0", "yargs": "^16.2.0" - } + }, + "keywords": [ + "kosmos", + "kredits" + ] }