Update CHANGELOG.md, README.md; release v1.0.0.alpha1

opal · Nov 11, 2022 · d06fe7e · d06fe7e
1 parent 4837217
commit d06fe7e
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,20 @@
 # Opal-RSpec Changelog
 
+## 1.0.0.alpha1 - 2022-11-11
+
+- Drop support for anything below Opal v1.6.alpha1
+
+- Update to the latest RSpec versions
+
+- Vendor-in `diff-lcs`
+
+- Rework the async logic to use the `await` feature of Opal
+  * If you use async features, it's crucial to use a `# await: *await*` magic comment (this will cause any call to a method containing an `await` word to be compiled with an `await` ES8 keyword)
+  * Both `let` and `subject` that return a promise (ie. are async) must be referenced with an `.await` method
+  * In `around` blocks, you must call `example.run_await` instead of just `example.run`
+  * Only `PromiseV2` is supported (`PromiseV1` may work, but you should migrate your application to use `PromiseV2` nevertheless, in Opal 2.0 it will become the default)
+
+
 ## 0.8.0 - 2021-12-01
 
 - Support for Opal v1.x

diff --git a/README.md b/README.md
@@ -252,7 +252,7 @@ Limitations:
 Changes since 1.0:
 
 * If you use async features, it's crucial to use a `# await: *await*` magic comment (this will cause any call to a method containing an `await` word to be compiled with an `await` ES8 keyword)
-* Both `let` and `subject` that return a promise (ie. are async; also if they) must be referenced with an `.await` method
+* Both `let` and `subject` that return a promise (ie. are async) must be referenced with an `.await` method
 * In `around` blocks, you must call `example.run_await` instead of just `example.run`
 * Only `PromiseV2` is supported (`PromiseV1` may work, but you should migrate your application to use `PromiseV2` nevertheless, in Opal 2.0 it will become the default)