Skip to content

Commit 1f20055

Browse files
committed
Add RELEASES.md to track changes between versions
1 parent bd1de9c commit 1f20055

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@ Intecture's APIs (_cough_ and a binary) are the heart and soul of Intecture. Che
1010
- [bindings](bindings/) - Rust FFI and language bindings
1111
- [proj](proj/) - Helpers and boilerplate for building Intecture projects
1212
- [agent](agent/) - Tiny daemon that exposes the core API as a service (for your hosts!)
13+
14+
## What's new?
15+
16+
Check out [RELEASES.md](RELEASES.md) for details.

RELEASES.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# 0.4.0 (in progress)
2+
3+
Version 0.4 is a complete rewrite of Intecture's core API. If we had been running a stable release (i.e. 1.0), this version would be version 2.0, but sadly we have to go with the far less dramatic 0.4 :(
4+
5+
Anyway, there are some big headlines in this release:
6+
7+
- **Hello Tokio!** This is an exciting change to our socket API, as we bid a fond farewell to ZeroMQ. The change to Tokio will bring loads of benefits, such as substantially reducing our non-Rust dependencies, and introducing strongly typed messaging between servers and clients. This will make our communications more robust and less open to exploitation. Woo hoo!
8+
- **Asynchronous endpoints with `Futures`!** This is another huge change to the API, allowing us to multitask our configurations. It will also pave the way for a streaming API, which has been sorely lacking in Intecture until now.
9+
- **Greater emphasis on composability.** Each endpoint (formerly called _primitives_) is organised into a collection of _providers_ that will (you guessed it) provide target-specific implementations of the endpoint. Users will be able to select an endpoint provider manually or let the system choose the best provider for the target platform.
10+
- **Separation of duties.** In the previous versions of Intecture, the API had been organised into a single project, making it cluttered and unwieldy. For the next release, things like the FFI, language bindings and project boilerplate will be moved into separate child projects under the same Cargo workspace.

0 commit comments

Comments
 (0)