diff --git a/README.md b/README.md index 266b979..9f422d7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ -# ngx-api-orm -Also lovingly called NAO +# NAO (ngx-api-orm) Some links to get you started: * [API Documentation](https://maurei.github.io/ngx-api-orm/). -* [NPM Package](https://www.npmjs.com/package/@ngx-api-orm/json-api) + +The NPM packages: + +* [Core package](https://www.npmjs.com/package/@ngx-api-orm/core) - This is the default package needed to start +* Optional packages: + * [Json:api implementation](https://www.npmjs.com/package/@ngx-api-orm/json-api) **Note: docs are still under construction.** -A rest api Object Relationship Mapper (ORM) for Angular. Tested with Angular 6.1.x. Can be use used seamlessly with [JSON:api](JsonApi.org) or easibly be adjusted to work with your own format. +A rest API Object Relationship Mapper (ORM) for Angular. Tested with Angular 6.1.x. Can be used seamlessly with [JSON:api](JsonApi.org) or easily be adjusted to work with your own format. It's aim is to remove as much boilerplate code as possible while allowing for easy extendability. It will empower your models with CRUD functionality and also manages to-one and to-many relationships. @@ -92,8 +96,9 @@ To get started you need the following: Using NPM (link to package [here](https://www.npmjs.com/package/@ngx-api-orm/json-api)): ```console npm install --save @ngx-api-orm/core +npm install --save @ngx-api-orm/json-api ``` -If you wish to install a specific version, you can use the following format: +If you wish to install a specific version, you can use the following format (if you would like to use 0.0.1-beta6 of the core package) ```console npm install --save @ngx-api-orm/core@0.0.1-beta6 ``` diff --git a/core/package-lock.json b/core/package-lock.json index a340c2b..fcbea88 100644 --- a/core/package-lock.json +++ b/core/package-lock.json @@ -1,6 +1,10 @@ { "name": "@ngx-api-orm/core", +<<<<<<< HEAD + "version": "0.0.1-beta10", +======= "version": "0.0.1-beta11", +>>>>>>> 3c0380e76f750099a598eb39f6cf564e10940e2e "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/ngx-api-orm.code-workspace b/ngx-api-orm.code-workspace new file mode 100644 index 0000000..362d7c2 --- /dev/null +++ b/ngx-api-orm.code-workspace @@ -0,0 +1,7 @@ +{ + "folders": [ + { + "path": "." + } + ] +} \ No newline at end of file