Skip to content

docs(README): mention local fangs more clearly #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kanarus merged 1 commit into from
Feb 22, 2025
Merged

docs(README): mention local fangs more clearly #403

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

```toml
[dependencies]
ohkami = { version = "0.23", features = ["rt_tokio"] }
ohkami = { version = "0.24", features = ["rt_tokio"] }
tokio = { version = "1", features = ["full"] }
```

Expand Down Expand Up @@ -363,7 +363,9 @@ async fn search(

### Middlewares

Ohkami's request handling system is called "**fang**s", and middlewares are implemented on this.
Ohkami's request handling system is called "**fang**s", and handlers and middlewares are built on this.

There are two types of fangs : *global fangs* and *local fangs*. While global fangs are registered to an `Ohkami`, local fangs are applied to a specific handler.

*builtin fang* :

Expand Down Expand Up @@ -394,9 +396,8 @@ impl FangAction for GreetingFang {
#[tokio::main]
async fn main() {
Ohkami::new((
// register fangs to a Ohkami
// register *global fangs* to an Ohkami
GreetingFang(1),

"/hello"
.GET(|| async {"Hello, fangs!"})
.POST((
Expand Down