Updated Readme and changelog.

JohannesKlauss · Aug 24, 2019 · 78f63dd · 78f63dd
1 parent 5e8369f
commit 78f63dd
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## [1.5.2] - 24-Aug-2019
+* Update readme.
+* Bump hotkeys version to 3.7.1
+
 ## [1.5.1] - 21-Jul-2019
 * Update readme.
 

diff --git a/README.md b/README.md
@@ -83,6 +83,13 @@ learn more and see an example where you have to set this array.
 
 Open up an issue or pull request and participate.
 
+### Local Development
+
+Checkout this repo, run `yarn` or `npm i` and then run the `docz:dev` script.
+You can use the `docs/useHotkeys.mdx` to test the behavior of the hook. It directly imports the
+`src/index.ts` file and transpiles it automatically. So you don't have to worry about. For more info
+on .mdx files, check out the docz documentation: https://www.docz.site/docs/writing-mdx
+
 ### Authors
 
 * Johannes Klauss