docs: improved docs

sayjava · Nov 15, 2021 · 81fab8e · 81fab8e
1 parent 3978734
commit 81fab8e
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -21,12 +21,18 @@ The easiest and quickest way to mock HTTP endpoints for development and testing
 
 # What is Deputy?
 
-Deputy is an HTTP API mock server that can aid in rapid application development by mocking endpoints and configuring responses from configurations.
+Deputy is an HTTP API mocking server that can aid in rapid application development by mocking endpoints and configuring responses from configurations.
 
 Deputy can also act as a testing server to validate what requests made by system under test.
 
-# Quick Start
 
+## Quick Start
+With nodejs
+```shell
+npx @sayjava/deputy
+```
+
+With docker
 ```shell
 docker run -p 8080:8080 -p 8081:8081 ghcr.io/sayjava/deputy
 ```
@@ -37,7 +43,7 @@ and test a sample endpoint
 curl http://localhost:8080/who-am-i
 ```
 
-# Features
+## Features
 
 -   [Declarative request matching and response](https://sayjava.github.io/deputy/guide)
 -   [Regex based request matching](https://sayjava.github.io/deputy/guide) (request path, headers and body matchers)
@@ -46,18 +52,32 @@ curl http://localhost:8080/who-am-i
 -   [Simulate response delays and network failures](https://sayjava.github.io/deputy/guide)
 -   [Inspect HTTP Requests and Response in realtime](https://sayjava.github.io/deputy/start)
 
-# Scenarios
+## Examples
 
-Here are some scenarios that Deputy can aid in your next development
+- [with-nextjs-commerce](examples/with-nextjs-commerce)
+- [with-nextjs-middleware](examples/with-nextjs-commerce)
+
+## Programitcally
+```javascript
+const express = require('express')
+const { createExpressMiddleware } = require('@sayjava/deputy')
+
+// mount the mock on a middleware endpoint
+const app = express()
+app.use('/api', createExpressMiddleware({ mocksFolder: 'fixtures' }))
+app.listen(3000, () => console.log('server started'))
+```
 
-## Transparently Mock & Forward API requests
+## Usage Scenarios
+Here are some setup scenarios that deputy can be used to aid development and testing
+### Transparently Mock & Forward API requests
 
 Simulate unready APIs by mocking some APIs and have other requests transparently forwarded to remote APIs
 See the examples/commerce folder using that uses the [next/commerce](next/commerces) + deputy
 
 ![Dev](./docs/media/dev_environment.png)
 
-## Application Testing
+### Application Testing
 
 Simulate complex HTTP requests and response scenarios in test environments
 

diff --git a/...th-express-middleware/mocks/mountain.json → ...ith-nextjs-middleware/mocks/mountain.json b/...th-express-middleware/mocks/mountain.json → ...ith-nextjs-middleware/mocks/mountain.json
diff --git a/...les/with-express-middleware/next-env.d.ts → ...ples/with-nextjs-middleware/next-env.d.ts b/...les/with-express-middleware/next-env.d.ts → ...ples/with-nextjs-middleware/next-env.d.ts
diff --git a/...ples/with-express-middleware/package.json → examples/with-nextjs-middleware/package.json b/...ples/with-express-middleware/package.json → examples/with-nextjs-middleware/package.json
diff --git a/...h-express-middleware/pages/api/weather.ts → ...th-nextjs-middleware/pages/api/weather.ts b/...h-express-middleware/pages/api/weather.ts → ...th-nextjs-middleware/pages/api/weather.ts
diff --git a/...s/with-express-middleware/pages/index.jsx → ...es/with-nextjs-middleware/pages/index.jsx b/...s/with-express-middleware/pages/index.jsx → ...es/with-nextjs-middleware/pages/index.jsx
diff --git a/...les/with-express-middleware/tsconfig.json → ...ples/with-nextjs-middleware/tsconfig.json b/...les/with-express-middleware/tsconfig.json → ...ples/with-nextjs-middleware/tsconfig.json