Skip to content

Commit 496b931

Browse files
authored
Update Readme
1 parent 38ba27e commit 496b931

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ enjoy [this blog post][blog] about Rayon, which gives more background
1313
and details about how it works, or [this video][video], from the Rust
1414
Belt Rust conference.) Rayon is
1515
[available on crates.io](https://crates.io/crates/rayon), and
16-
[API Documentation is available on docs.rs](https://docs.rs/rayon/).
16+
[API documentation is available on docs.rs](https://docs.rs/rayon).
1717

1818
[blog]: https://smallcultfollowing.com/babysteps/blog/2015/12/18/rayon-data-parallelism-in-rust/
1919
[video]: https://www.youtube.com/watch?v=gof_OEv71Aw
@@ -74,9 +74,9 @@ as:
7474
rayon = "1.6"
7575
```
7676

77-
To use the Parallel Iterator APIs, a number of traits have to be in
77+
To use the parallel iterator APIs, a number of traits have to be in
7878
scope. The easiest way to bring those things into scope is to use the
79-
[Rayon prelude](https://docs.rs/rayon/*/rayon/prelude/index.html). In
79+
[Rayon prelude](https://docs.rs/rayon/*/rayon/prelude/index.html). In
8080
each module where you would like to use the parallel iterator APIs,
8181
just add:
8282

@@ -88,22 +88,33 @@ Rayon currently requires `rustc 1.56.0` or greater.
8888

8989
### Usage with WebAssembly
9090

91-
Rayon can work on the Web via WebAssembly, but requires an adapter
92-
and some project configuration to account for differences between
91+
Rayon can work on the Web via WebAssembly, but requires an adapter and
92+
some project configuration to account for differences between
9393
WebAssembly threads and threads on the other platforms.
9494

95-
Check out [wasm-bindgen-rayon](https://github.com/GoogleChromeLabs/wasm-bindgen-rayon)
95+
Check out the
96+
[wasm-bindgen-rayon](https://github.com/GoogleChromeLabs/wasm-bindgen-rayon)
9697
docs for more details.
9798

9899
## Contribution
99100

100-
Rayon is an open source project! If you'd like to contribute to Rayon, check out [the list of "help wanted" issues](https://github.com/rayon-rs/rayon/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). These are all (or should be) issues that are suitable for getting started, and they generally include a detailed set of instructions for what to do. Please ask questions if anything is unclear! Also, check out the [Guide to Development](https://github.com/rayon-rs/rayon/wiki/Guide-to-Development) page on the wiki. Note that all code submitted in PRs to Rayon is assumed to [be licensed under Rayon's dual MIT/Apache2 licensing](https://github.com/rayon-rs/rayon/blob/master/README.md#license).
101+
Rayon is an open source project! If you'd like to contribute to Rayon,
102+
check out
103+
[the list of "help wanted" issues](https://github.com/rayon-rs/rayon/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
104+
These are all (or should be) issues that are suitable for getting
105+
started, and they generally include a detailed set of instructions for
106+
what to do. Please ask questions if anything is unclear! Also, check
107+
out the
108+
[Guide to Development](https://github.com/rayon-rs/rayon/wiki/Guide-to-Development)
109+
page on the wiki. Note that all code submitted in PRs to Rayon is
110+
assumed to
111+
[be licensed under Rayon's dual MIT/Apache 2.0 licensing](https://github.com/rayon-rs/rayon/blob/master/README.md#license).
101112

102113
## Quick demo
103114

104115
To see Rayon in action, check out the `rayon-demo` directory, which
105116
includes a number of demos of code using Rayon. For example, run this
106-
command to get a visualization of an nbody simulation. To see the
117+
command to get a visualization of an n-body simulation. To see the
107118
effect of using Rayon, press `s` to run sequentially and `p` to run in
108119
parallel.
109120

0 commit comments

Comments
 (0)