From 04d4a6340b25c352aa60f6fa682f11148b5c453a Mon Sep 17 00:00:00 2001 From: Matt Boutet Date: Fri, 13 Nov 2020 14:01:47 -0500 Subject: [PATCH] Updates to Readme, move this over into a version branch --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cfc5250..73baf2d 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,14 @@ Auto-generated, RESTful, CRUDdy route handlers Lead Maintainer - [Matt Boutet](https://github.com/mattboutet) +## Installation +```sh +npm install @hapipal/tandy +``` + > **Note** > -> This plugin is intended to work with [hapi](https://github.com/hapijs/hapi) v19+ and its [Objection ORM](https://github.com/Vincit/objection.js/) plugin, [schwifty](https://github.com/BigRoomStudios/Schwifty/). +> This plugin is intended to work with [hapi](https://github.com/hapijs/hapi) v19+ and its [Objection ORM](https://github.com/Vincit/objection.js/) plugin, [schwifty](https://github.com/hapipal/schwifty). ## What it does Tandy registers route handlers based upon the `method` and `path` of your route. It turns them into RESTful API endpoints that automatically interact with models defined through Schwifty. By default Tandy will infer which models to use from the request path. The route handler is based on one of eight Tandys: @@ -126,7 +131,7 @@ These options allow you to act on behalf of the authenticated user. Typically t - `where` (string). Applies to `find`. - Extracts only those records that fulfill a specified condition. (i.e. `createdDate = '2019-08-19'`)(overridden by `where` query parameter). + Extracts only those records that fulfill a specified condition. (i.e. `createdDate = '2019-08-19'`)(overridden by `where` query parameter). ## Usage Here's an (over)simplified example.