rescript-relay 2.0.0-alpha.0 → 2.0.0

package/CHANGELOG.md

@@ -1,9 +1,29 @@
 # master
 
+# 2.0.0
+
+RescriptRelay `2.0.0` is here! This isn't a large release really, but it's a major release just because it relies on functionality from ReScript `v11`. Meaning the lower bound of the required ReScript version is `>=11.0.0-beta.2`.
+
+### Uncurried mode
+
+`2.0.0` is built to work with uncurried mode. It's not fully _optimized_, that'll come in `3.0.0`, but it works well in uncurried mode.
+
+You can activate uncurried mode with `RescriptRelay` by setting `"uncurried": true` (`true` is also the default in ReScript `>=11.0.0-beta.2`) in your `bsconfig.json`, and then ensuring that you pass `-uncurried` to `rescript-relay/ppx` in `ppx-flags`: `"ppx-flags": [["rescript-relay/ppx", "-uncurried"]]`.
+
+# 2.0.0-alpha.1
+
+## Improvements
+
+- `%relay.deferredComponent` now works with uncurried mode.
+
 # 2.0.0-alpha.0
 
 First alpha of the `2.x` series of releases. `2.x` focuses on compat with ReScript `v11`, including uncurried mode.
 
+### Uncurried mode
+
+You can activate uncurried mode with `RescriptRelay` by setting `"uncurried": true` in your `bsconfig.json`, and then ensuring that you pass `-uncurried` to `rescript-relay/ppx` in `ppx-flags`: `"ppx-flags": [["rescript-relay/ppx", "-uncurried"]]`.
+
 ## Upgrade versions
 
 - `rescript` to `>=11.0.0-beta.0`

package/README.md

@@ -98,6 +98,14 @@ let make = () => {
 
 ```
 
+## Note about versioning
+
+There's plenty of work ongoing to bring RescriptRelay to full ReScript v11 support, including uncurried mode. Here's the versioning scheme that'll be followed going forward:
+
+- 1.x will receive critical bug fixes etc, but new features won't be added
+- 2.x will soon ship, and it'll focus on compatibility with ReScript v11, and uncurried mode (uncurried mode will be optional). This is intended to make the transition to v11+ smooth
+- 3.x will also soon ship, and that'll fully embrace uncurried mode (no curried mode available), and add a bunch of new stuff + change existing APIs to make them better and more ergonomic
+
 ## Examples
 
 - A general example showcasing most available features: https://github.com/zth/rescript-relay/tree/master/example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rescript-relay",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0",
   "main": "src/RescriptRelay.res",
   "license": "MIT",
   "author": "Gabriel Nordeborn",