Skip to content

Commit b502ad3

Browse files
committed
Start a new README
1 parent 19b973e commit b502ad3

File tree

1 file changed

+45
-8
lines changed

1 file changed

+45
-8
lines changed

README.md

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,40 @@ https://github.com/async-std/async-std)
77
[![Documentation](https://docs.rs/async-std/badge.svg)](https://docs.rs/async-std)
88
[![chat](https://img.shields.io/discord/598880689856970762.svg?logo=discord)](https://discord.gg/JvZeVNe)
99

10-
This crate is an async version of [`std`].
10+
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.
11+
12+
For detailed information, take a look at the [documentation][docs] and the associated [book][book].
1113

1214
[`std`]: https://doc.rust-lang.org/std/index.html
15+
[docs]: https://docs.rs/async-std
16+
[book]: https://book.async.rs
1317

1418
## Quickstart
1519

16-
Clone the repo:
20+
Add the following lines to you `Cargo.toml`:
1721

22+
<<<<<<< HEAD
1823
```
1924
git clone git@github.com:async-rs/async-std.git && cd async-std
25+
=======
26+
```toml
27+
[dependencies]
28+
async-std = "0.99"
29+
>>>>>>> Start a new README
2030
```
2131

22-
Read the docs:
32+
Or use [cargo add][cargo-add] if you have it installed:
2333

34+
<<<<<<< HEAD
2435
```
2536
cargo doc --features docs --open
37+
=======
38+
```sh
39+
$ cargo add async-std
40+
>>>>>>> Start a new README
2641
```
2742

28-
Check out the [examples](examples). To run an example:
29-
30-
```
31-
cargo run --example hello-world
32-
```
43+
[cargo add]: https://github.com/killercup/cargo-edit
3344

3445
## Hello world
3546

@@ -45,6 +56,32 @@ fn main() {
4556
}
4657
```
4758

59+
## Take a look around
60+
61+
Clone the repo:
62+
63+
```
64+
git clone git@github.com:stjepang/async-std.git && cd async-std
65+
```
66+
67+
Read the docs:
68+
69+
```
70+
cargo doc --features docs.rs --open
71+
```
72+
73+
Check out the [examples](examples). To run an example:
74+
75+
```
76+
cargo run --example hello-world
77+
```
78+
79+
## Contributing
80+
81+
See [our contribution document][contribution].
82+
83+
[contribution]: https://async.rs/contribute
84+
4885
## License
4986

5087
Licensed under either of

0 commit comments

Comments
 (0)