Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobwgillespie committed Jul 4, 2021
1 parent 67ecf16 commit 078354b
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
# ⚡ zap

Zap is a lightweight HTTP server framework for Node.

## Installation

Install with your favorite package manager:

```shell
$ yarn add zap
$ pnpm add zap
$ npm install zap
```

## Usage

```typescript
import {route, router, serve} from 'zap'

const app = router(
route('GET', '/', () => 'Hello World'),

route('GET', '/hello/:name', (req) => `Hello ${req.params.name}`),
)

const server = http.createServer(serve(app))
server.listen(3000)
```

## License

MIT License, see `LICENSE`.

0 comments on commit 078354b

Please sign in to comment.