From d22f059b4ea77d693c6a1bdb5b22f784ad825eab Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Thu, 23 Apr 2020 14:05:49 -0400 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20add=20yarn=20comma?= =?UTF-8?q?nds=20to=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 56ada70ea..50588fb56 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ subproject, e.g. running or testing. - [Prerequisites](#prerequisites) - [Installation](#installation) +- [Yarn Commands](#yarn-commands) - [Contributing](#contributing) - [Branching](#branching) - [Building ToC](#building-toc) @@ -40,6 +41,16 @@ You will need the following things properly installed on your computer. * `cd watchtower-ui` * `yarn install` +## Yarn Commands + +List of available project commands. `yarn run ` + +| Command | Description | +|---------------------|--------------------------------------------------------------------------------------------------------------------| +| commit | Replaces `git commit`, ensures checks pass before commit is allowed and normalizes commit messages across authors. | +| compliance:licenses | Checks that all dependencies have OSS-compatible licenses. | +| build:toc | Automatically generates a ToC for the README file. | + ## Contributing ### Branching