From 73a1561299c8339ce7f8ad759d8a910c066a563d Mon Sep 17 00:00:00 2001 From: Jeremiah Senkpiel Date: Tue, 20 Feb 2018 12:21:29 -0500 Subject: [PATCH] Document the project's high-level approach PR-URL: https://github.com/Fishrock123/bob/pull/7 --- readme.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/readme.md b/readme.md index 02ec351..90d2734 100644 --- a/readme.md +++ b/readme.md @@ -4,6 +4,17 @@ A Work-In-Progress binary data "streams+" implementation via data producers, dat _The name? something something B~~L~~OB, credit Matteo Collina._ +## Project Approach +This is [a Node.js strategic initiative](strategic-initiatives) aiming to improve Node.js streaming data interfaces, both within Node.js core internally, and hopefully also as future public APIs. + +High-level timeline: +- Prototype separate from core entirely. +- Move into nodejs org once JS & C++ APIs are significantly prototyped. +- Begin transitioning Node.js internals once the APIs and perf are proved. +- If an internal transition works out well, begin planning public APIs. + +All of these steps necessitate the buy-in of many stakeholders, both in Node.js core and the greater Node.js ecosystem. This is a long-term project by necessity and design. + ## Goals Some collective goals for this initiative. @@ -49,3 +60,5 @@ Please see [performance.md](performance.md) for profiling results & information. ## License [MIT Licensed](license) — _[Contributions via DCO 1.1](contributing.md#developers-certificate-of-origin)_ + +[strategic-initiatives]: https://github.com/nodejs/TSC/blob/master/Strategic-Initiatives.md#current-initiatives