Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-22 09:32:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
Karl-Philipp Wulfert
2018-12-13 12:53:42 +01:00
parent 1a07df2d67
commit 67a692c08a
1 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -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 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. * 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. * Search interface must be clearly specified that different working groups with different search tools can retrieve the same search results.
* Must be expandable. * 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
```