mirror of
https://github.com/honojs/hono.git
synced 2024-11-21 18:18:57 +01:00
7738c99062
* chore: add conf file to categorize the PRs on release note Inspired by https://github.com/r7kamura/github-label-presets * docs: rename `master` to `main` and remove README from middlewre directories If you want read the document about the middleware, please refer to the website <https://honojs.dev/>
89 lines
3.1 KiB
Markdown
89 lines
3.1 KiB
Markdown
<div align="center">
|
|
<a href="https://honojs.dev">
|
|
<img src="https://raw.githubusercontent.com/honojs/hono/main/docs/images/hono-title.png" width="500" height="auto" alt="Hono"/>
|
|
</a>
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
<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 />
|
|
|
|
[](https://github.com/honojs/hono/actions)
|
|
[](https://github.com/honojs/hono/blob/main/LICENSE)
|
|
[](https://www.npmjs.com/package/hono)
|
|
[](https://www.npmjs.com/package/hono)
|
|
[](https://www.npmjs.com/package/hono)
|
|
[](https://github.com/honojs/hono/pulse)
|
|
[](https://github.com/honojs/hono/commits/main)
|
|
[](https://doc.deno.land/https/deno.land/x/hono/mod.ts)
|
|
|
|
Hono - _**[炎] means flame🔥 in Japanese**_ - is a small, simple, and ultrafast web framework for Cloudflare Workers, Deno, Bun, and others.
|
|
|
|
```ts
|
|
import { Hono } from 'hono'
|
|
const app = new Hono()
|
|
|
|
app.get('/', (c) => c.text('Hono!!'))
|
|
|
|
export default app
|
|
```
|
|
|
|
## Features
|
|
|
|
- **Ultrafast** - the router does not use linear loops.
|
|
- **Zero-dependencies** - using only Service Worker and Web Standard API.
|
|
- **Middleware** - built-in middleware, custom middleware, and third-party middleware.
|
|
- **TypeScript** - first-class TypeScript support.
|
|
- **Multi-platform** - works on Cloudflare Workers, Fastly Compute@Edge, Deno, or Bun.
|
|
|
|
## Benchmarks
|
|
|
|
**Hono is fastest**, compared to other routers for Cloudflare Workers.
|
|
|
|
```plain
|
|
hono - trie-router(default) x 389,510 ops/sec ±3.16% (85 runs sampled)
|
|
hono - regexp-router x 452,290 ops/sec ±2.64% (84 runs sampled)
|
|
itty-router x 206,013 ops/sec ±3.39% (90 runs sampled)
|
|
sunder x 323,131 ops/sec ±0.75% (97 runs sampled)
|
|
worktop x 191,218 ops/sec ±2.70% (91 runs sampled)
|
|
Fastest is hono - regexp-router
|
|
✨ Done in 43.56s.
|
|
```
|
|
|
|
## Documentation
|
|
|
|
The documentation is available on [honojs.dev](https://honojs.dev).
|
|
|
|
## Migration
|
|
|
|
Migration guide is available on [docs/MIGRATION.md](docs/MIGRATION.md)
|
|
|
|
## Contributing
|
|
|
|
Contributions Welcome! You can contribute in the following ways.
|
|
|
|
- Fix bugs.
|
|
- Create built-in or third-party middleware.
|
|
- Propose new feature.
|
|
- Refactor the code.
|
|
- Write an article about Hono on your Blog.
|
|
- Fix a typo.
|
|
- etc.
|
|
|
|
## Contributors
|
|
|
|
Thanks to [all contributors](https://github.com/honojs/hono/graphs/contributors)! Especially, [@metrue](https://github.com/metrue) and [@usualoma](https://github.com/usualoma)!
|
|
|
|
## Author
|
|
|
|
Yusuke Wada <https://github.com/yusukebe>
|
|
|
|
## License
|
|
|
|
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
|