Skip to content
This repository was archived by the owner on Feb 8, 2024. It is now read-only.

Commit 315b7be

Browse files
committed
Update readme
1 parent 369f088 commit 315b7be

2 files changed

Lines changed: 34 additions & 4 deletions

File tree

File renamed without changes.

README.md renamed to readme.md

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,11 @@ Docs at https://atomixinteractions.github.io/createrest
1616
## Usage example
1717

1818
```js
19+
// routes.js
1920
const {
2021
createRest,
2122
printRoutes,
2223
} = require('createrest')
23-
const { createRestExpress } = require('createrest-express')
24-
const express = require('express')
25-
26-
const app = express()
2724

2825
const before1 = () => { console.log('before1()') }
2926
const before2 = () => { console.log('before2()') }
@@ -69,14 +66,47 @@ const routes = createRest(root => {
6966
})
7067
})
7168

69+
module.exports = routes
70+
```
71+
72+
### Express
73+
74+
More in it's repo [createrest-express](https://atmx.in/rest-ex)
75+
76+
```js
77+
const { createRestExpress } = require('createrest-express')
78+
const express = require('express')
79+
const routes = require('./routes')
80+
81+
const app = express()
82+
7283
app.use(createRestExpress(routes))
7384

7485
app.listen(4001, () => {
7586
printRoutes(routes)
7687
})
88+
```
7789

90+
### Koa
91+
92+
More in it's repo [createrest-koa](https://atmx.in/rest-koa)
93+
94+
```js
95+
const Koa = require('koa')
96+
const { createKoaRouter } = require('createrest-koa')
97+
const routes = require('./routes')
98+
99+
const app = new Koa()
100+
const router = createKoaRouter(routes)
101+
102+
app.use(router.routes(), router.allowedMethods())
103+
104+
app.listen(3000, () => {
105+
printRoutes(routes)
106+
})
78107
```
79108

109+
---
80110

81111
Output:
82112

0 commit comments

Comments
 (0)