doc: BrowserHistory is supported, but not HashHistory

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.6.6] - 2018-09-15
+### Added
+- Note in README.md that BrowserHistory is supported, but not HashHistory
+
+## [1.6.5] - 2018-09-02
+### Added
+- Demo to README.md
+
 ## [1.6.4] - 2018-07-25
 ### Fixed
 - Only set state if mounted

README.md

@@ -8,6 +8,8 @@
 
 #### Overview
 
+#### Demo
+
 #### Example Usage
 
 #### API
@@ -16,6 +18,8 @@
 
 Promps user to confirm navigation. A replacement component for the react-router `<Prompt/>` (this still uses react-router to work). Allows for more flexible dialogs.
 
+Note: Currently tested using only react-router's `BrowserHistory`. `HashHistory` has issues: https://github.com/ZacharyRSmith/react-router-navigation-prompt/issues/36
+
 Note: Navigation away from your site, reload, or closing tab/window will also prompt navigation confirmation when `<NavigationPrompt/>`'s `props.when` is truthy. Usually, browsers handle this navigation UX themselves, leading to vanilla alert boxes. Also, many browsers require users to interact with your site before confirming navigation away.
 
 Motivation: https://github.com/ReactTraining/react-router/issues/4635

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-router-navigation-prompt",
-  "version": "1.6.5",
+  "version": "1.6.6",
   "description": "A replacement component for the react-router `<Prompt/>`. Allows for more flexible dialogs.",
   "scripts": {
     "build": "webpack",