From 9297b112894200f16da7042cf2344270ae40c8e1 Mon Sep 17 00:00:00 2001 From: Harro van der Kroft Date: Fri, 1 Mar 2019 11:31:26 +0100 Subject: [PATCH] docs: small update, should add NPM specific package documentation --- README.md | 4 +++- core/README.md | 6 +++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9f422d7..7569e78 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # NAO (ngx-api-orm) -Some links to get you started: + +This is an API interpreter with a focus on Json:Api. Some links to get you started: + * [API Documentation](https://maurei.github.io/ngx-api-orm/). The NPM packages: diff --git a/core/README.md b/core/README.md index 228880e..434d16f 100644 --- a/core/README.md +++ b/core/README.md @@ -1,3 +1,7 @@ # ngx-api-orm core -(See the main repo.)[https://github.com/maurei/ngx-api-orm/] \ No newline at end of file +This is the core of `ngx-api-orm` on top of this you can add: + +* The Json:Api adapter + +The main repo is located [here](https://github.com/maurei/ngx-api-orm/). \ No newline at end of file