From 30e08fd205e878d424a2fbc6fc919e7fd4fd734f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6nke=20Ludwig?= Date: Tue, 4 Oct 2016 17:52:46 +0200 Subject: [PATCH] Update README. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 85a6589..0e98b79 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,26 @@ vibe.d core module ================== +This is the designated successor of the `vibe-d:core` sub package of [vibe.d 0.7.x](https://github.com/rejectedsoftware/vibe.d.git). The API is mostly compatible from a library user point of view, but the whole library has received some heavy lifting under the surface, close to a rewrite. Most classes have been replaced by reference counting structs and `@safe nothrow` attributes are now used throughout the library, whenever possible. Adding `@nogc` still has to be decided, because of its viral nature. + +Another major design change is that instead of the previous driver model, there is now a separate, lower-level event loop abstraction ([eventcore](https://github.com/vibe-d/eventcore.git)) which follows a callback based Proactor pattern. The logic to schedule fibers based on events has been pulled out of this abstraction and is now maintained as a single function, leaving to a huge improvment in terms of robustness (most issues in the previous implementation have probably never surfaced in practice, but there turned out to be lots of hidden bugs). + +The development state is still heavy work-in-progress. [![Build Status](https://travis-ci.org/vibe-d/vibe-core.svg?branch=master)](https://travis-ci.org/vibe-d/vibe-core) + + +Progress +-------- + +Feature | State +--------------------|--------- +Task scheduling | done +Concurrency | done +Streams | WIP +DNS lookup | --- +TCP connections | done +UDP connections | --- +File I/O | --- +Directory watchers | --- +ManualEvent | unstable