docs: make readme nicer

This commit is contained in:
Karl-Philipp Wulfert
2018-12-03 14:41:49 +01:00
parent 06bbbd4891
commit e3404793db

View File

@@ -1,9 +1,19 @@
# @openstapps/projectmanagement
This repository contains documentation, project resources and cli tools to manage the `@openstapps` projects.
## Project management tool
This is a small cli tool that helps to maintain the project(s).
```shell
npm install @openstapps/projectmanagement
openstapps-projectmanagement --help
```
## Pack
This cli tool can pack multiple JavaScript-/TypeScript-definition-files into 2 single files - one for the code and one for the definitions. This is explicitly used for the `@openstapps/core`.
```shell
openstapps-pack --help
```