docs(rest): update readme #1158
Conversation
packages/rest/README.md
Outdated
| @@ -12,18 +12,17 @@ with: | |||
| - new custom routing engine (special thanks to @bajtos)! | |||
| - tools for defining your application routes | |||
| - OpenAPI 2.0 spec (`swagger.json`/`swagger.yaml`) generation | |||
| - a default sequence implementation to manage the request and response lifecycle | |||
| - a default sequence implementation to manage the request and response life cycle | |||
There was a problem hiding this comment.
what's wrong with "lifecycle"? :)
There was a problem hiding this comment.
Apparently life cycle is the more correct usage / grammar as per online dictionaries and a VSCode extension I installed. That said, I can revert this change (I prefer lifecycle as well).
There was a problem hiding this comment.
Go with whatever you think that's correct.
i originally thought (coming from my son's learning material) life cycle is more like some biological cycle that living things go through. But i'm no english expert. :)
| ``` | ||
|
|
||
| ## Basic Use | ||
| Here's a basic "Hello World" application using `@loopback/core` and | ||
| `@loopback/rest`: | ||
| Here's a basic "Hello World" application using `@loopback/rest`: | ||
|
|
||
| ```ts | ||
| import {RestApplication, RestServer} from '@loopback/rest'; |
There was a problem hiding this comment.
super minor nitpick: extract out rest.getSync('rest.port') since that's what we do in the CLI generated template
packages/rest/README.md
Outdated
| @@ -12,18 +12,17 @@ with: | |||
| - new custom routing engine (special thanks to @bajtos)! | |||
| - tools for defining your application routes | |||
| - OpenAPI 2.0 spec (`swagger.json`/`swagger.yaml`) generation | |||
|
In regards to swagger stuff, maybe we should mention that the actual code that generates the swagger spec lives outside of rest and in |
packages/rest/README.md
Outdated
|
|
||
| ## Contributions | ||
|
|
||
| - [Guidelines](https://github.com/strongloop/loopback-next/wiki/Contributing#guidelines) | ||
| - [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/DEVELOPING.md) |
There was a problem hiding this comment.
I think it'd be better to link to https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md which serves as the overall guideline and points to our DEVELOPING doc as needed.
|
@slnode test please |
connected to #988
connected to #988
Checklist
npm testpasses on your machinepackages/cliwere updatedpackages/example-*were updated