Skip to content

Commit 96d686d

Browse files
committed
Add link to CRUD wiki
1 parent b844ebe commit 96d686d

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- a collection of helpers that allow you to stand up APIs rapidly
88
- extremely opinionated
99
- driven by PostgreSQL functions
10-
- all APIs revolve around SCRUD actions
10+
- all APIs revolve around [SCRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) actions
1111
- all resource actions have default handlers but can be individually overridden
1212

1313
# who is it for
@@ -23,7 +23,7 @@ $ npm install --save scrud
2323

2424
# api
2525

26-
### register(name, options)
26+
### scrud.register(name, options)
2727
- Registers a resource as an API, enabling it to respond to SCRUD actions against it
2828
- A common pattern would be registering resources that correlate to database tables
2929
- Does not have to correlate to a database table
@@ -59,7 +59,7 @@ $ npm install --save scrud
5959
- type: `Function` - receives (http.ClientRequest, http.ServerResponse)
6060
- default: calls `${namespace}_${resource}_delete(IN jsonb, OUT jsonb)` PG function and responds to client with data (success) or error
6161

62-
### start(options)
62+
### scrud.start(options)
6363
Set global options and start API server
6464

6565
***Returns:*** Promise which with resolves with http.Server
@@ -72,8 +72,8 @@ Set global options and start API server
7272
- **namespace** - *optional* - namespace to use in PG function calls (i.e. `${namespace}_${resource}_${action}`). If not set the PG function called will be `${resource}_${action}`
7373
- type: `String`
7474
- default: `null`
75-
- **postgres** - *required if using DB backed actions* - configuration for [pg](https://github.com/brianc/node-postgres) connection
76-
- type: `Object` matching config specs for [pg](https://github.com/brianc/node-postgres)
75+
- **postgres** - *required if using DB backed actions* - configuration for [node-postgres](https://github.com/brianc/node-postgres) connection
76+
- type: `Object` matching config specs for [node-postgres](https://github.com/brianc/node-postgres)
7777
- default: `null`
7878
- **jsonwebtoken** - *required for JWT authentication* - configuration for [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) connection
7979
- type: `Object` that contains options from both the `sign` and `verify` methods at [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken)

0 commit comments

Comments
 (0)