0
0
mirror of https://github.com/honojs/hono.git synced 2024-11-28 00:26:24 +01:00
hono/README.md
2022-12-21 06:42:27 +09:00

3.7 KiB


Documentation 👉 honojs.dev
v2.x has been released! Migration guide


GitHub Workflow Status GitHub npm npm npm type definitions GitHub commit activity GitHub last commit Deno badge Discord badge

Hono - [炎] means flame🔥 in Japanese - is a small, simple, and ultrafast web framework for Cloudflare Workers, Deno, Bun, and others.

import { Hono } from 'hono'
const app = new Hono()

app.get('/', (c) => c.text('Hono!!'))

export default app

Features

  • Ultrafast - The routers are really smart. Not using linear loops. The fastest one will be selected from three routers.
  • Zero-dependencies - Using only Web Standard API. Does not depend on other npm or Deno libraries.
  • Middleware - Hono has built-in middleware, custom middleware, and third-party middleware. Batteries included.
  • TypeScript - First-class TypeScript support. Now, we've got "Types".
  • Multi-runtime - Works on Cloudflare Workers, Fastly Compute@Edge, Deno, Bun, or Node.js. The same code runs on all platforms.

Benchmarks

Hono is fastest, compared to other routers for Cloudflare Workers.

Hono x 616,464 ops/sec ±4.76% (83 runs sampled)
itty-router x 203,074 ops/sec ±3.66% (88 runs sampled)
sunder x 314,306 ops/sec ±2.28% (87 runs sampled)
worktop x 194,111 ops/sec ±2.78% (81 runs sampled)
Fastest is Hono
✨  Done in 30.77s.

Documentation

The documentation is available on honojs.dev.

Migration

Migration guide is available on docs/MIGRATION.md.

Communication

Twitter and Discord channel are available.

Contributing

Contributions Welcome! You can contribute in the following ways.

  • 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.

Contributors

Thanks to all contributors! Especially, @metrue and @usualoma!

Author

Yusuke Wada https://github.com/yusukebe

License

Distributed under the MIT License. See LICENSE for more information.