@@ -7,29 +7,40 @@ https://github.com/async-std/async-std)
7
7
[ ![ Documentation] ( https://docs.rs/async-std/badge.svg )] ( https://docs.rs/async-std )
8
8
[ ![ chat] ( https://img.shields.io/discord/598880689856970762.svg?logo=discord )] ( https://discord.gg/JvZeVNe )
9
9
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 ] .
11
13
12
14
[ `std` ] : https://doc.rust-lang.org/std/index.html
15
+ [ docs ] : https://docs.rs/async-std
16
+ [ book ] : https://book.async.rs
13
17
14
18
## Quickstart
15
19
16
- Clone the repo :
20
+ Add the following lines to you ` Cargo.toml ` :
17
21
22
+ <<<<<<< HEAD
18
23
```
19
24
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
20
30
```
21
31
22
- Read the docs :
32
+ Or use [ cargo add ] [ cargo-add ] if you have it installed :
23
33
34
+ <<<<<<< HEAD
24
35
```
25
36
cargo doc --features docs --open
37
+ =======
38
+ ```sh
39
+ $ cargo add async-std
40
+ >>>>>>> Start a new README
26
41
```
27
42
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
33
44
34
45
## Hello world
35
46
@@ -45,6 +56,32 @@ fn main() {
45
56
}
46
57
```
47
58
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
+
48
85
## License
49
86
50
87
Licensed under either of
0 commit comments