fix(readme): Updated readme

jamestalton · Feb 10, 2019 · 0d779ce · 0d779ce
1 parent 2af4357
commit 0d779ce
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,29 @@
 # KOA REST API Router for MongoDB
 
+A router that exposes a standard REST API for a MongoDB.
+
 ## Status: BETA
 
 [![Build Status](https://travis-ci.com/jamestalton/koa-mongo-router.svg?branch=master)](https://travis-ci.com/jamestalton/koa-mongo-router)
 
+## Usage
+
+```bash
+npm install koa-mongo-router
+```
+
+```TypeScript
+const mongoRouter = getMongoRouter()
+const app = new Koa().use(mongoRouter.routes()).use(mongoRouter.allowedMethods())
+```
+
 ## REST API
 
 1. [REST Operations](#REST-Operations)
 1. [Query String](#Query-String)
 1. [Authentication]()
 
-## REST Operations
+### REST Operations
 
 | Method | Route                      | Description                            |
 | -----: | -------------------------- | -------------------------------------- |
@@ -24,7 +37,9 @@
 |  PATCH | /:database/:collection/:id | [Update an item](#Get-Item)            |
 | DELETE | /:database/:collection/:id | [Delete an item](#Get-Item)            |
 
-### Get Items
+#### Get Items
+
+Get items from a collection. Items can be filtered, paged, sorted, and counted using [query string](#Query-String) parameters.
 
 | Request | Parameters             | Notes           |
 | ------: | ---------------------- | --------------- |
@@ -34,13 +49,9 @@
 |   Codes | 200 Success            |
 |         | 304 Not Modified       | Conditional GET |
 
-Get items from a collection. Items can be filtered, paged, sorted, and counted using [query string](#Query-String) parameters.
-
-Example:
-
-> GET /library/books?bookName=A Tale of Two Cities
+#### Create An Item
 
-### Create An Item
+Create a new item. This creates a new \_id and assigns it to the item.
 
 |      Request | Parameters                 |
 | -----------: | -------------------------- |
@@ -50,28 +61,7 @@ Example:
 |      Returns | The id of the created item |
 | Status Codes | 201 Created                |
 
-Create a new item. This creates a new id and assigns it to the item.
-
-## REST API Routes
-
-| Method | Route            | Body   | Headers          | Query | Description                                |
-| -----: | ---------------- | ------ | ---------------- | ----- | ------------------------------------------ |
-|    GET | /:collection     |        |                  |       | Get items                                  |
-|    PUT | /:collection     | Array  |                  |       | Replace collection                         |
-|    PUT | /:collection     | Array  |                  | ?!    | Create or replace items                    |
-|    PUT | /:collection     | Array  | If-None-Match:\* | ?!    | Create items that do not already exist.    |
-|    PUT | /:collection     | Array  | If-Match:\*      | ?!    | Replace items only if item already exists  |
-|   POST | /:collection     | Object |                  |       | Create item                                |
-|  PATCH | /:collection     | Object |                  |       | Update items                               |
-| DELETE | /:collection     |        |                  |       | Delete collection                          |
-|    GET | /:collection/:id |        |                  |       | Get Item                                   |
-|    PUT | /:collection/:id | Object |                  |       | Create or replace item                     |
-|    PUT | /:collection/:id | Object | If-None-Match:\* |       | Create item if item does not already exist |
-|    PUT | /:collection/:id | Object | If-Match:\*      |       | Replace item if item already exists        |
-|  PATCH | /:collection/:id | Object |                  |       | Update item                                |
-| DELETE | /:collection/:id | Object |                  |       | Delete item                                |
-
-## Query String Options
+### Query String Options
 
 |     Option | Description                    | Example                    |
 | ---------: | ------------------------------ | -------------------------- |
@@ -82,7 +72,7 @@ Create a new item. This creates a new id and assigns it to the item.
 |    \$count | Return the total count header  | ?\$count                   |
 | \$paginate | Return pagination header       | ?\$paginate                |
 
-## Query String Filtering
+### Query String Filtering
 
 |                                 Operation | Query String       |
 | ----------------------------------------: | ------------------ |

diff --git a/src/app.ts b/src/app.ts
@@ -12,7 +12,7 @@ import { createAppServer, shutdownAppServer } from './server'
 let server: Server | Http2SecureServer
 
 export async function startApp() {
-    const mongoRouter = await getMongoRouter()
+    const mongoRouter = getMongoRouter()
 
     const app = new Koa()
         .use(requestLogger)

diff --git a/src/mongo-router.ts b/src/mongo-router.ts
@@ -332,7 +332,7 @@ export interface IMongoRouterOptions {
     permissionCheck?: (database: string, collection: string) => Promise<boolean>
 }
 
-export async function getMongoRouter(options?: IMongoRouterOptions) {
+export function getMongoRouter(options?: IMongoRouterOptions) {
     const mongoRouter = new Router()
 
     if (options != undefined && options.permissionCheck != undefined) {

diff --git a/test/mongo-router.spec.ts b/test/mongo-router.spec.ts
@@ -13,7 +13,7 @@ let request: axios.AxiosInstance
 let server: Server | Http2SecureServer
 
 beforeAll(async function() {
-    const mongoRouter = await getMongoRouter()
+    const mongoRouter = getMongoRouter()
     const app = new Koa().use(mongoRouter.routes())
     server = await createAppServer(app.callback())
     const port = (server.address() as AddressInfo).port