mirrors/ntex
1
0
Fork 0
mirror of https://github.com/ntex-rs/ntex.git synced 2025-04-04 05:17:39 +03:00
Code Issues Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Nikolay Kim 2022-01-05 02:17:57 +06:00
parent 9cb52bd37b
commit 08c0dd5654
3 changed files with 23 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,6 +1,6 @@
<div align="center"> <div align="center">
<p><h1>ntex</h1> </p> <p><h1>ntex</h1> </p>
<p><strong>Framework for composable network services. This project uses *unsafe*!</strong> </p> <p><strong>Framework for composable network services.</strong> </p>
<p> <p>
[![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28Linux%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(Linux)") [![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28Linux%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(Linux)")
@ -21,6 +21,16 @@
| macOS | [![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28OSX%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(OSX)") | | macOS | [![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28OSX%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(OSX)") |
| Windows | [![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28Windows%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(Windows)") | | Windows | [![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28Windows%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(Windows)") |
## Usage
Starting ntex v0.5 async runtime must be selected as a feature. Available options are `tokio`
or `async-std`.
```toml
[dependencies]
ntex = { version = "0.5", features = ["tokio"] }
```
## Documentation & community resources ## Documentation & community resources
* [Documentation](https://docs.rs/ntex) * [Documentation](https://docs.rs/ntex)

2
ntex/Cargo.toml
View file

@ -14,7 +14,7 @@ license = "MIT"
edition = "2018" edition = "2018"
[package.metadata.docs.rs] [package.metadata.docs.rs]
features = ["openssl", "rustls", "compress", "cookie"] features = ["tokio", "openssl", "rustls", "compress", "cookie"]
[lib] [lib]
name = "ntex" name = "ntex"

12
ntex/README.md
View file

@ -1,6 +1,6 @@
<div align="center"> <div align="center">
<p><h1>ntex</h1> </p> <p><h1>ntex</h1> </p>
<p><strong>Framework for composable network services. This project uses *unsafe*!</strong> </p> <p><strong>Framework for composable network services.</strong> </p>
<p> <p>
[![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28Linux%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(Linux)") [![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28Linux%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(Linux)")
@ -21,6 +21,16 @@
| macOS | [![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28OSX%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(OSX)") | | macOS | [![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28OSX%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(OSX)") |
| Windows | [![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28Windows%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(Windows)") | | Windows | [![build status](https://github.com/ntex-rs/ntex/workflows/CI%20%28Windows%29/badge.svg?branch=master&event=push)](https://github.com/ntex-rs/ntex/actions?query=workflow%3A"CI+(Windows)") |
## Usage
Starting ntex v0.5 async runtime must be selected as a feature. Available options are `tokio`
or `async-std`.
```toml
[dependencies]
ntex = { version = "0.5", features = ["tokio"] }
```
## Documentation & community resources ## Documentation & community resources
* [Documentation](https://docs.rs/ntex) * [Documentation](https://docs.rs/ntex)