8000 Improve readme. · socketry/async@6dfc3bb · GitHub
[go: up one dir, main page]
Skip to content

Commit 6dfc3bb

Browse files
ioquatixioquatix
committed
Improve readme.
1 parent 1188953 commit 6dfc3bb

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

‎guides/links.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ event-loop:
77
asynchronous-tasks:
88
order: 2
99
best-practices:
10-
order: 3
10+
order: 5

‎readme.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# ![Async](logo.svg)
22

3-
Async is a composable asynchronous I/O framework for Ruby based on [io-event](https://github.com/socketry/io-event) and [timers](https://github.com/socketry/timers).
3+
Async is a composable asynchronous I/O framework for Ruby based on [io-event](https://github.com/socketry/io-event) and
4+
[timers](https://github.com/socketry/timers).
45

5-
> "Lately I've been looking into `async`, as one of my projects – [tus-ruby-server](https://github.com/janko/tus-ruby-server) – would really benefit from non-blocking I/O. It's really beautifully designed." *– [janko](https://github.com/janko)*
6+
> "Lately I've been looking into `async`, as one of my projects –
7+
> [tus-ruby-server](https://github.com/janko/tus-ruby-server) – would really benefit from non-blocking I/O. It's really
8+
> beautifully designed." *– [janko](https://github.com/janko)*
69
7-
[![Development Status](https://github.com/socketry/async/workflows/Test/badge.svg)](https://github.com/socketry/async/actions?workflow=Test)
10+
[![Development
11+
Status](https://github.com/socketry/async/workflows/Test/badge.svg)](https://github.com/socketry/async/actions?workflow=Test)
812

913
## Features
1014

@@ -15,7 +19,22 @@ Async is a composable asynchronous I/O framework for Ruby based on [io-event](ht
1519

1620
## Usage
1721

18-
Please see the [project documentation](https://socketry.github.io/async).
22+
Please see the [project documentation](https://github.com/socketry/async) for more details.
23+
24+
- [Getting Started](https://github.com/socketry/asyncguides/getting-started/index) - This guide gives shows how to add
25+
async to your project and run code asynchronously.
26+
27+
- [Asynchronous Tasks](https://github.com/socketry/asyncguides/asynchronous-tasks/index) - This guide explains how
28+
asynchronous tasks work and how to use them.
29+
30+
- [Event Loop](https://github.com/socketry/asyncguides/event-loop/index) - This guide gives an overview of how the
31+
event loop is implemented.
32+
33+
- [Compatibility](https://github.com/socketry/asyncguides/compatibility/index) - This guide gives an overview of the
34+
compatibility of Async with Ruby and other frameworks.
35+
36+
- [Best Practices](https://github.com/socketry/asyncguides/best-practices/index) - This guide gives an overview of
37+
best practices for using Async.
1938

2039
## Contributing
2140

0 commit comments

Comments
 (0)
0