mirror of
https://github.com/async-rs/async-std.git
synced 2025-02-28 07:09:40 +00:00
Start a new README
This commit is contained in:
parent
19b973ef03
commit
b502ad3c6c
1 changed files with 45 additions and 8 deletions
53
README.md
53
README.md
|
@ -7,29 +7,40 @@ https://github.com/async-std/async-std)
|
|||
[](https://docs.rs/async-std)
|
||||
[](https://discord.gg/JvZeVNe)
|
||||
|
||||
This crate is an async version of [`std`].
|
||||
This crate provices an async version of [`std`]. It provides all the interfaces you are used to, but async and ready for Rusts `async/await`-syntax.
|
||||
|
||||
For detailed information, take a look at the [documentation][docs] and the associated [book][book].
|
||||
|
||||
[`std`]: https://doc.rust-lang.org/std/index.html
|
||||
[docs]: https://docs.rs/async-std
|
||||
[book]: https://book.async.rs
|
||||
|
||||
## Quickstart
|
||||
|
||||
Clone the repo:
|
||||
Add the following lines to you `Cargo.toml`:
|
||||
|
||||
<<<<<<< HEAD
|
||||
```
|
||||
git clone git@github.com:async-rs/async-std.git && cd async-std
|
||||
=======
|
||||
```toml
|
||||
[dependencies]
|
||||
async-std = "0.99"
|
||||
>>>>>>> Start a new README
|
||||
```
|
||||
|
||||
Read the docs:
|
||||
Or use [cargo add][cargo-add] if you have it installed:
|
||||
|
||||
<<<<<<< HEAD
|
||||
```
|
||||
cargo doc --features docs --open
|
||||
=======
|
||||
```sh
|
||||
$ cargo add async-std
|
||||
>>>>>>> Start a new README
|
||||
```
|
||||
|
||||
Check out the [examples](examples). To run an example:
|
||||
|
||||
```
|
||||
cargo run --example hello-world
|
||||
```
|
||||
[cargo add]: https://github.com/killercup/cargo-edit
|
||||
|
||||
## Hello world
|
||||
|
||||
|
@ -45,6 +56,32 @@ fn main() {
|
|||
}
|
||||
```
|
||||
|
||||
## Take a look around
|
||||
|
||||
Clone the repo:
|
||||
|
||||
```
|
||||
git clone git@github.com:stjepang/async-std.git && cd async-std
|
||||
```
|
||||
|
||||
Read the docs:
|
||||
|
||||
```
|
||||
cargo doc --features docs.rs --open
|
||||
```
|
||||
|
||||
Check out the [examples](examples). To run an example:
|
||||
|
||||
```
|
||||
cargo run --example hello-world
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
See [our contribution document][contribution].
|
||||
|
||||
[contribution]: https://async.rs/contribute
|
||||
|
||||
## License
|
||||
|
||||
Licensed under either of
|
||||
|
|
Loading…
Reference in a new issue