From 67a692c08a193550df187dee68283bf53703b348 Mon Sep 17 00:00:00 2001 From: Karl-Philipp Wulfert Date: Thu, 13 Dec 2018 12:53:42 +0100 Subject: [PATCH] docs: update readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 06c016bd..07e34664 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -# README +# @openstapps/core + +[![pipeline status](https://img.shields.io/gitlab/pipeline/openstapps/core.svg?style=flat-square)](https://gitlab.com/openstapps/core/commits/master) +[![npm](https://img.shields.io/npm/v/@openstapps/core.svg?style=flat-square)](https://npmjs.com/package/@openstapps/core) +[![license)](https://img.shields.io/npm/l/@openstapps/core.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html) +[![documentation](https://img.shields.io/badge/documentation-online-blue.svg?style=flat-square)](https://openstapps.gitlab.io/core) StAppsCore - Generalized model of data @@ -16,3 +21,11 @@ Data sources of the same type of data are assigned to the same SC-type. * It must be platform- and software-independent. * Search interface must be clearly specified that different working groups with different search tools can retrieve the same search results. * Must be expandable. + +### Generate documentation for routes + +To generate a documentation for the routes use the following command. + +```shell +node --require ts-node/register src/cli.ts routes PATH/TO/ROUTES.md +```