docs: ✏️ add yarn commands to readme

This commit is contained in:
Randall Morey committed 2020-04-23 14:05:49 -04:00
1 parent f3a71f46eb
commit d22f059b4e
1 file changed
+11
+11
View File
@@ -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-name>`
| 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