From e3404793db44eb7b8e70c848feca9a181221a703 Mon Sep 17 00:00:00 2001 From: Karl-Philipp Wulfert Date: Mon, 3 Dec 2018 14:41:49 +0100 Subject: [PATCH] docs: make readme nicer --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 697e531f..2fcf65c9 100755 --- a/README.md +++ b/README.md @@ -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 ```