Skip to content

Commit e3a37b4

Browse files
authored
docs: improve README (#516)
* docs: improve README * fix a phrase
1 parent adb5507 commit e3a37b4

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Hello, your_name!
7373

7474
- `.GET()`, `.POST()`, `.PUT()`, `.PATCH()`, `.DELETE()`, `.OPTIONS()` to define API endpoints
7575
- `.By({another Ohkami})` to nest `Ohkami`s
76-
- `.Mount({directory_path})` to serve static directory
76+
- `.Mount({directory path})` to serve static directory
7777
(pre-compressed files with `gzip`, `deflate`, `br`, `zstd` are supported)
7878

7979
Here `GET`, `POST`, etc. takes a *handler* function:
@@ -83,24 +83,30 @@ async fn({FromRequest type},*) -> {IntoResponse type}
8383
```
8484

8585
On native runtimes, whole a handler must be `Send + Sync + 'static`
86-
and the return type must be `Send + 'static`.
86+
and the return future must be `Send + 'static`.
8787

8888
### `claw`s
8989

9090
Ohkami provides `claw` API: handler parts for declarative way to
9191
extract request data and construct response data.
9292

93-
- `content` - content {extracted from request / for response} of specific format as type
93+
- `content` - typed content {extracted from request / for response} of specific format
9494
- built-in: `Json<T>`, `Text<T>`, `Html<T>`, `UrlEncoded<T>`, `Multipart<T>`
95-
- `param` - parameter extracted from request as type
95+
- `param` - typed parameters extracted from request
9696
- built-in: `Path<P>`, `Query<T>`
97-
- `header` - specific header extracted from request as type
97+
- `header` - types for specific header extracted from request
9898
- built-in: types for standard request headers
99-
- `status` - response with specific status code as type
99+
- `status` - types for response with specific status code
100100
- built-in: types for standard response status codes
101101

102-
( `T` means a type that implements `serde::Deserialize` for request and `serde::Serialize` for response,
103-
and `P` means a type that implements `FromParam` or a tuple of such types. )
102+
<sm><i>(
103+
here <code>T</code> means a type that implements
104+
<code>serde::Deserialize</code> for request and
105+
<code>serde::Serialize</code> for response,
106+
and <code>P</code> means a type that implements
107+
<code>FromParam</code> or
108+
a tuple of such types.
109+
)</i></sm>
104110

105111
The number of path parameters extracted by `Path` is **automatically asserted**
106112
to be the same or less than the number of path parameters contained in the route path
@@ -190,7 +196,7 @@ Ohkami::new((
190196
)).howl("localhost:3000").await;
191197
```
192198

193-
`.howls()` (`tls` feature only), is used to run Ohkami with TLS (HTTPS) support
199+
`.howls()` (`tls` feature only) is used to run Ohkami with TLS (HTTPS) support
194200
with [`rustls`](https://github.com/rustls) ecosystem (described in `tls` feature section).
195201

196202
`howl(s)` supports graceful shutdown by `Ctrl-C` or `SIGTERM` signal on native runtimes.

0 commit comments

Comments
 (0)