/README.md (raw)

# hare-aio – asynchronous event loop

This project seeks to develop an asynchronous event loop API.

It is designed to backed by `io_uring` rather than `epoll`; however, when BSD
support is added, we'd probably still use `kqueue`.

Most users should consider using [hare-ev](https://git.sr.ht/~sircmpwn/hare-ev)
instead, since it is more mature and less prone to breakages.

## Acknowedgements

Some of the following projects provided inspiration, some we just lifted code
from:

* [hare-ev](https://git.sr.ht/~sircmpwn/hare-ev)
* [hare-iobus](https://git.sr.ht/~sircmpwn/hare-iobus)
* [hare-linux](https://git.sr.ht/~sircmpwn/hare-linux)
* [toothbrush](https://git.sr.ht/~sircmpwn/toothbrush)

## Contributing

Create a branch that begins with `contrib/` and push to the
[main repo](https://forge.lindenii.org/hare/:/repos/hare-aio/)
via SSH directly.

```
git clone ssh://forge.lindenii.org/hare/:/repos/hare-aio/
cd hare-aio
git checkout -b contrib/whatever
# edit and commit stuff
git push -u origin HEAD
```

## Support

[`#chat`](https://webirc.runxiyu.org/gamja/#chat)
on
[irc.runxiyu.org](https://irc.runxiyu.org/).