Create CHANGELOG

mars · Jul 5, 2016 · abec3ba · abec3ba
1 parent 57b3577
commit abec3ba
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/CHANGELOG.markdown b/CHANGELOG.markdown
@@ -0,0 +1,30 @@
+Episode 7 Changelog
+===================
+
+This module adhears to semver, incrementing major version for any breaking change.
+
+v1.1
+----
+
+* `Episode7.run` now supports yielding to generators, in addition to promises
+* `Episode7.call` now supports a `this` argument for side-effect functions:
+
+  Before (v1.0.x)
+  ```javascript
+  function* awesomeGen() {
+    yield Episode7.call(neatSideEffect)
+  }
+  ```
+
+  Now (v1.1.0)
+  ```javascript
+  function* awesomeGen() {
+    yield Episode7.call([this, neatSideEffect])
+  }
+  ```
+* Guardrail errors inform the developer if `yield` is used without `Episode7.call`
+
+
+v1.0
+----
+Initial release
diff --git a/README.markdown b/README.markdown
@@ -28,6 +28,11 @@ Install
 npm install episode-7 --save
 ```
 
+Changes
+-------
+
+See: [CHANGELOG](CHANGELOG.markdown)
+
 Usage
 -----