added Location docs

Author: ryanflorence

Diff for: docs/api/components/Routes.md

@@ -10,17 +10,19 @@ Props
 
 ### `location`
 
-One of `"hash"` or `"history"`, defaults to `"hash"`.
+One of `"hash"`, `"history"` or a user defined location implementation,
+defaults to `"hash"`.
 
-Configures what type of url you want. `"hash"` includes `#/` in the url and
-works without a server, if you use `history` your server will need to
-support it.
+`"hash"` includes `#/` in the url and works without a server, if you use
+`history` your server will need to support it.
 
 For browsers that don't support the HTML5 history API the router will
 fall back to `window.location` if you choose `history`, in other words,
 the router will simply cause a full page reload. This way all users get
 the same urls and can share them.
 
+See also: [user supplied locations][Location].
+
 ### `preserveScrollPosition`
 
 If `true`, the router will not scroll the window up globally when any
@@ -63,3 +65,5 @@ var routes = (
 React.renderComponent(routes, document.body);
 ```
 
+  [Location]:../misc/Location.md
+

Diff for: docs/api/misc/Location.md

@@ -0,0 +1,66 @@
+API: `Location` (object)
+==========================
+
+You can supply the router with your own location implementation. The
+following methods must be implemented:
+
+Methods
+-------
+
+### `setup(onChange)`
+
+Called when the router is first setup. Whenever an external actor should
+cause the router to react, call `onChange` (for example, on
+`window.hashchange`).
+
+### `teardown`
+
+Called when the router is torn down.
+
+### `push`
+
+Called when the router is transitioning from one path to another.
+
+### `replace`
+
+Called when ther router is replacing (not transitioning) one url with
+another.
+
+### `pop`
+
+Called when the router attempts to go back one entry in the history.
+
+### `getCurrentPath`
+
+Should return the current path as a string.
+
+### `toString`
+
+Should return a useful string for logging and debugging.
+
+Example
+-------
+
+This is a terrible example, you're probably better off looking at the
+implementations in this repository.
+
+```js
+var MyLocation = {
+
+  setup: function (onChange) {},
+
+  teardown: function () {},
+
+  push: function (path) {},
+
+  replace: function (path) {},
+
+  pop: function () {},
+
+  getCurrentPath: function () {},
+
+  toString: function () {}
+
+};
+```
+