From cf21e896abb6350e9d7582a0e53772d4b396b487 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dietmar=20K=C3=BChl?= Date: Tue, 17 Sep 2024 19:01:08 +0100 Subject: [PATCH 1/2] improved the README a bit --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c83338e..69f62fc 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It is based on [P2762](http://wg21.link/p2762). Both the proposal and the implementation are in an early state although basic functionality is provided. -`beman.net29` builds on top of [`beman.execution26`](). The +`beman.net29` builds on top of [`beman.execution26`](https://github.com/beman-project/execution26). The implementation should allow multiple ways how to support asynchronous operations although currently the only implemented approach is based on `poll(2)`. Implementations using `kqueue(2)`, `epoll(2)`, @@ -13,6 +13,27 @@ on `poll(2)`. Implementations using `kqueue(2)`, `epoll(2)`, possible use various libraries for asynchronous operations like `libevent`, `libuv`, etc. +## Help Welcome! + +There are plenty of things which need to be done. Some of these +are listed in the [issues section](https://github.com/beman-project/net29/issues). +Other contributions are, of course, also welcome. + +If you want to contribute, you won't be left alone! Please e-mail +[Dietmar Kühl](mailto:dietmar.kuehl@me.com) if want help or mentoring +for contributing to the library. + +## State of the Proposal + +At the February 2024/Tokyo meeting the Networking SG4 discussion +recommended _not_ to provide a low-level interface for networking! +Instead, a [IETF TAPS](https://datatracker.ietf.org/wg/taps/documents/) +based implementation should be used. As a result, the shape of the +interface will be different. However, even if the public interface +is using [IETF TAPS](https://datatracker.ietf.org/wg/taps/documents/) +the implementation will use a lower-level interface which can likely +use something akin to the current interface. + ## Building Currently, the interfaces are entirely implemented in headers, i.e., From f5eb5665618c0a16968c7ff85e7610df522f5236 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dietmar=20K=C3=BChl?= Date: Tue, 17 Sep 2024 19:04:02 +0100 Subject: [PATCH 2/2] small tweak to the contribution section --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 69f62fc..f6a0d53 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,9 @@ possible use various libraries for asynchronous operations like There are plenty of things which need to be done. Some of these are listed in the [issues section](https://github.com/beman-project/net29/issues). -Other contributions are, of course, also welcome. +Other contributions are, of course, also welcome. Aside from contributing +code the project welcomes reports on usage experience, code reviews, defect +reports, features requests, etc. There are plenty contribution opportunities. If you want to contribute, you won't be left alone! Please e-mail [Dietmar Kühl](mailto:dietmar.kuehl@me.com) if want help or mentoring