2022-04-22 01:45:52 +02:00
< div align = "center" >
2022-07-16 10:51:34 +02:00
< a href = "https://honojs.dev" >
2022-07-18 04:48:34 +02:00
< img src = "https://raw.githubusercontent.com/honojs/hono/main/docs/images/hono-title.png" width = "500" height = "auto" alt = "Hono" / >
2022-04-22 01:45:52 +02:00
< / a >
< / div >
< hr / >
2021-12-14 21:17:56 +01:00
2022-07-16 10:51:34 +02:00
< p align = "center" >
< a href = "https://honojs.dev" > < b > Documentation :point_right: honojs.dev< / b > < / a > < br / >
< i > v2.x has been released!< / i > < a href = "docs/MIGRATION.md" > Migration guide< / b >
< / p >
< hr / >
2022-04-26 10:15:16 +02:00
[![GitHub Workflow Status ](https://img.shields.io/github/workflow/status/honojs/hono/ci )](https://github.com/honojs/hono/actions)
2022-07-18 04:48:34 +02:00
[![GitHub ](https://img.shields.io/github/license/honojs/hono )](https://github.com/honojs/hono/blob/main/LICENSE)
2022-02-21 16:01:31 +01:00
[![npm ](https://img.shields.io/npm/v/hono )](https://www.npmjs.com/package/hono)
2022-02-23 03:20:29 +01:00
[![npm ](https://img.shields.io/npm/dm/hono )](https://www.npmjs.com/package/hono)
2022-02-21 16:01:31 +01:00
[![npm type definitions ](https://img.shields.io/npm/types/hono )](https://www.npmjs.com/package/hono)
2022-04-26 10:15:16 +02:00
[![GitHub commit activity ](https://img.shields.io/github/commit-activity/m/honojs/hono )](https://github.com/honojs/hono/pulse)
2022-07-18 04:48:34 +02:00
[![GitHub last commit ](https://img.shields.io/github/last-commit/honojs/hono )](https://github.com/honojs/hono/commits/main)
2022-07-02 14:48:32 +02:00
[![Deno badge ](https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Flatest-version%2Fx%2Fhono%2Fmod.ts )](https://doc.deno.land/https/deno.land/x/hono/mod.ts)
2022-02-21 16:01:31 +01:00
2022-07-08 02:22:10 +02:00
Hono - _**[炎] means flame🔥 in Japanese**_ - is a small, simple, and ultrafast web framework for Cloudflare Workers, Deno, Bun, and others.
2021-12-17 07:53:31 +01:00
2022-05-13 05:30:06 +02:00
```ts
2022-01-09 13:10:12 +01:00
import { Hono } from 'hono'
2022-01-01 07:29:41 +01:00
const app = new Hono()
2021-12-17 07:53:31 +01:00
2022-01-05 21:11:37 +01:00
app.get('/', (c) => c.text('Hono!!'))
2021-12-17 07:53:31 +01:00
2022-07-16 10:51:34 +02:00
export default app
2021-12-17 07:53:31 +01:00
```
2022-01-08 01:48:22 +01:00
## Features
2021-12-17 07:53:31 +01:00
2022-02-23 03:20:29 +01:00
- **Ultrafast** - the router does not use linear loops.
2022-05-13 05:30:06 +02:00
- **Zero-dependencies** - using only Service Worker and Web Standard API.
2022-07-10 17:34:55 +02:00
- **Middleware** - built-in middleware, custom middleware, and third-party middleware.
2022-04-10 16:24:52 +02:00
- **TypeScript** - first-class TypeScript support.
2022-07-08 02:22:10 +02:00
- **Multi-platform** - works on Cloudflare Workers, Fastly Compute@Edge, Deno, or Bun.
2021-12-14 21:17:56 +01:00
2022-07-02 11:29:09 +02:00
## Benchmarks
2022-03-06 02:27:26 +01:00
**Hono is fastest**, compared to other routers for Cloudflare Workers.
2022-01-05 10:41:29 +01:00
2022-01-08 21:30:50 +01:00
```plain
2022-08-21 03:11:53 +02:00
hono - trie-router(default) x 437,354 ops/sec ±4.58% (83 runs sampled)
hono - regexp-router x 535,157 ops/sec ±3.46% (83 runs sampled)
itty-router x 203,092 ops/sec ±3.64% (89 runs sampled)
sunder x 308,252 ops/sec ±2.17% (91 runs sampled)
worktop x 190,764 ops/sec ±3.11% (86 runs sampled)
2022-05-27 10:16:43 +02:00
Fastest is hono - regexp-router
2022-08-21 03:11:53 +02:00
✨ Done in 38.26s.
2021-12-27 17:34:09 +01:00
```
2022-07-16 10:51:34 +02:00
## Documentation
2022-07-08 02:22:10 +02:00
2022-07-16 10:51:34 +02:00
The documentation is available on [honojs.dev ](https://honojs.dev ).
2021-12-14 21:31:37 +01:00
2022-07-16 10:51:34 +02:00
## Migration
2022-01-05 21:11:37 +01:00
2022-07-23 02:46:20 +02:00
Migration guide is available on [docs/MIGRATION.md ](docs/MIGRATION.md ).
2021-12-14 21:31:37 +01:00
2022-01-05 21:11:37 +01:00
## Contributing
2022-04-26 00:58:08 +02:00
Contributions Welcome! You can contribute in the following ways.
2022-01-05 21:11:37 +01:00
2022-07-23 02:46:20 +02:00
- Create an Issue - Propose a new feature. Report a bug.
- Pull Request - Fix a bug and typo. Refactor the code.
- Create third-party middleware - Instruct below.
- Share - Share your thoughts on the Blog, Twitter, and others.
- Make your application - Please try to use Hono.
For more details, see [docs/CONTRIBUTING.md ](docs/CONTRIBUTING.md ).
2022-01-05 21:11:37 +01:00
2022-02-15 09:19:53 +01:00
## Contributors
2022-05-13 05:30:06 +02:00
Thanks to [all contributors ](https://github.com/honojs/hono/graphs/contributors )! Especially, [@metrue ](https://github.com/metrue ) and [@usualoma ](https://github.com/usualoma )!
2022-02-15 09:19:53 +01:00
2021-12-14 20:26:22 +01:00
## Author
Yusuke Wada < https: / / github . com / yusukebe >
## License
2022-01-07 09:34:12 +01:00
Distributed under the MIT License. See [LICENSE ](LICENSE ) for more information.