Skip to content

Commit

Permalink
Merge pull request #122 from compio-rs/doc/readme
Browse files Browse the repository at this point in the history
doc: add contribution section to README.md
  • Loading branch information
Berrysoft authored Oct 23, 2023
2 parents e57a43a + da72e8f commit 566db61
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Add `compio` as dependency:
```
compio = { version = "0.8.0", features = ["macros"] }
```

Then we can use high level APIs to perform filesystem & net IO.

```rust
Expand All @@ -46,3 +47,9 @@ async fn main() {
```

You can also control the low-level driver manually. See `driver` example of the repo.

## Contributing

There are opportunities to contribute to Compio at any level. It doesn't matter if
you are just getting started with Rust or are the most weathered expert, we can
use your help. If you have any question about Compio, feel free to join our [telegram group](https://t.me/compio_rs). Before contributing, please checkout our [contributing guide](https://github.com/compio-rs/compio/blob/master/CONTRIBUTING.md).

0 comments on commit 566db61

Please sign in to comment.