Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Carmine DiMascio committed Jun 10, 2017
1 parent 3940703 commit ae06b46
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Create awesome [Express.js](www.expressjs.com) applications with best of breed tech including ES.next via [Babel.js](https://babeljs.io/), structured logging with [Pino](https://github.com/pinojs/pino), API validation and interactive documentation via [Swagger](http://swagger.io/), environment based config with [dotenv](https://github.com/motdotla/dotenv), and [Backpack](https://github.com/palmerhq/backpack) powered builds.

![](https://github.com/cdimascio/generator-express-no-stress/raw/master/assets/swagger_node.jpeg)
![](https://raw.githubusercontent.com/cdimascio/generator-express-no-stress/master/assets/swagger_node.jpeg)

generator-express-no-stress gets you up and running in seconds. It's ridiculously easy to configure. Heck, just take the defaults. Start it. Write code.

Expand Down Expand Up @@ -76,13 +76,14 @@ Simply describe your APIs with Swagger and automagically get for free:
- API validation

#### Interactive API Doc
![](https://github.com/cdimascio/generator-express-no-stress/raw/master/assets/interactive-doc1.png)
![](https://raw.githubusercontent.com/cdimascio/generator-express-no-stress/master/assets/interactive-doc1.png)


#### API Validation!
Oops! I the API caller forgot to pass a `name` field, no stress, we've got this!

![](https://github.com/cdimascio/generator-express-no-stress/raw/master/assets/api-validation.png)
![](https://raw.githubusercontent.com/cdimascio/generator-express-no-stress/master/assets/api-validation.png)



### Structured Logging
Expand All @@ -91,13 +92,13 @@ Structured logging out of the box!

#### raw

![](https://github.com/cdimascio/generator-express-no-stress/raw/master/assets/logging-raw.png)
![](https://raw.githubusercontent.com/cdimascio/generator-express-no-stress/master/assets/logging-raw.png)

#### pretty

Structured logging pretty printed by default - great for dev!

![](https://github.com/cdimascio/generator-express-no-stress/raw/master/assets/logging-pretty.png)
![](https://raw.githubusercontent.com/cdimascio/generator-express-no-stress/master/assets/logging-pretty.png)

### API Validation Example

Expand Down Expand Up @@ -189,7 +190,7 @@ paths:

#### Invoke a POST request via the Interactive doc

![](https://github.com/cdimascio/generator-express-no-stress/raw/master/assets/interactive-doc.png)
![](https://raw.githubusercontent.com/cdimascio/generator-express-no-stress/master/assets/interactive-doc.png)



Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "generator-express-no-stress",
"version": "3.0.1",
"version": "3.0.2",
"description": "Create awesome APIs with ExpressJS and Swagger.",
"main": "app/index.js",
"scripts": {
Expand Down

0 comments on commit ae06b46

Please sign in to comment.