api-core - npm Package Compare versions

Comparing version 0.0.9-alpha.7 to 0.0.9-alpha.8

package.json

 {
   "name": "api-core",
-  "version": "0.0.9-alpha.7",
+  "version": "0.0.9-alpha.8",
   "description": "Lightweight framework for building dynamic multi-level APIs for any provider (Express, socket.io, etc.), consumable via multiple channels (HTTP, socket.io, etc.)",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,3 +0,5 @@
-# API Core
+**API Core**
 
+Lightweight framework for building dynamic multi-level APIs for any provider (Express, socket.io, etc.), consumable via multiple channels (HTTP, socket.io, etc.)
+
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/ajuhos/api-core/master/LICENSE)
@@ -8,6 +10,6 @@ [![GitHub issues](https://img.shields.io/github/issues/ajuhos/api-core.svg)](https://github.com/ajuhos/api-core/issues)
 
-Features:
+## Features
 
  - Dynamic model-based API routes
- - Extensible API queries with pre- and post-query steps
+ - Extensible API queries with pre- and post-query steps  (coming soon)
      - Transformations (via api-core-mapper or your own library)
@@ -18,9 +20,9 @@ - Authentication, ACL (via node-acl, passport, etc.)
  - Multi database APIs (different database for every route, if you need)
+ - Versioned APIs
 
-###### UNDER DEVELOPMENT
-First beta and documentation coming soon...
+## Installation
 
-## Basics
+**API Core is in ``alpha`` and NOT ready for production use.**
 
-### Installation
+To install the latest version, use NPM:
 
@@ -31,4 +33,6 @@ ```bash
 
-### API Edges
+## Basics
 
+#### API Edges
+
 In API Core every API is built from edges. 
@@ -57,3 +61,3 @@ An edge defines operations and relations of a Data Model.
 
-### API Providers
+#### API Providers
 
@@ -66,13 +70,12 @@ You can use API Providers to make your API consumable via different
  - HTTP
-     - _Express: api-provider-express_
-     - _Koa: api-provider-koa_
-     - _Restify: api-provder-restify_
+     - _Express: api-provider-express (coming soon)_
+     - _Koa: api-provider-koa (coming soon)_
+     - _Restify: api-provder-restify (coming soon)_
      - Ellipse: [api-provider-ellipse](https://github.com/ajuhos/api-provider-ellipse)
  - Socket
-     - _socket.io: api-provider-socket.io_
+     - _socket.io: api-provider-socket.io (coming soon)_
      
 Also you can implement your own API provider.
-For more information take a look at [api-provider](https://github.com/ajuhos/api-provider).
 
-### Data Models
+#### Data Models
 
@@ -88,9 +91,8 @@ Every API requires a set of data models. As with API Providers, you have
   
-
 Also you can implement your own API model library.
 
-## SNEAK PEAK
+## Usage
 
-We have two working samples in the following repository, one with a 
-local in-memory model and one with a Mongoose model.
+We have two working examples in the following repository, one with a 
+local in-memory model (master branch) and one with a Mongoose model (mongodb branch).
 
@@ -180,1 +182,17 @@ Working Demo: [api-demo](https://github.com/ajuhos/api-demo)
 ```
+
+## Tests
+
+We maintain high test coverage to provide a reliable framework 
+for your APIs.
+
+To run tests, execute the following NPM commands:
+
+```bash
+npm install
+npm test
+```
+
+## License
+
+The [MIT License](https://github.com/ajuhos/api-core/blob/master/LICENSE). Free forever. :)

No alert changes

Improved metrics

Total package byte prevSize

501148

increased by0.36%

Number of lines in readme file

191

increased by9.77%

No dependency changes