From 23a7120f76acc85fdcadc03c2d1f465f006cc5a5 Mon Sep 17 00:00:00 2001 From: Ross Brodbeck Date: Thu, 16 Apr 2020 14:18:06 -0400 Subject: [PATCH] Update the readme on how to build it --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 1e2e7dc4..5f51a10d 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,23 @@ Warns and then closes issues and PRs that have had no activity for a specified amount of time. +### Building and testing + +Install the dependencies +```bash +$ npm install +``` + +Build the typescript and package it for distribution +```bash +$ npm run build && npm run pack +``` + +Run the tests :heavy_check_mark: +```bash +$ npm test +``` + ### Usage See [action.yml](./action.yml) For comprehensive list of options.