Skip to content

Commit e5ffffd

Browse files
committed
Document the project's high-level approach
1 parent 7cf4e45 commit e5ffffd

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

readme.md

+13
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ A Work-In-Progress binary data "streams+" implementation via data producers, dat
44

55
_The name? something something B~~L~~OB, credit Matteo Collina._
66

7+
## Project Approach
8+
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.
9+
10+
High-level timeline:
11+
- Prototype separate from core entirely.
12+
- Move into nodejs org once JS & C++ APIs are significantly prototyped.
13+
- Begin transitioning Node.js internals once the APIs and perf are proved.
14+
- If an internal transition works out well, begin planning public APIs.
15+
16+
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.
17+
718
## Goals
819
Some collective goals for this initiative.
920

@@ -49,3 +60,5 @@ Please see [performance.md](performance.md) for profiling results & information.
4960
## License
5061

5162
[MIT Licensed](license)_[Contributions via DCO 1.1](contributing.md#developers-certificate-of-origin)_
63+
64+
[strategic-initiatives]: https://github.com/nodejs/TSC/blob/master/Strategic-Initiatives.md#current-initiatives

0 commit comments

Comments
 (0)