readme

Author: icd2k3

README.md

@@ -62,38 +62,23 @@ Pathname | Result
 
 ## API
 
-#### withBreadcrumbs
 ```js
-import { withBreadcrumbs } from 'react-router-breadcrumbs-hoc';
-
-withBreadcrumbs(routes)(Component): HigherOrderComponent
+Route = {
+  path: String
+  breadcrumb: String|Function
+  matchOptions?: Object
+}
+
+Breadcrumb = {
+  path: String
+  match: String
+  breadcrumb: Component
+}
+
+withBreadcrumbs(routes: Array<Route>): HigherOrderComponent
+getBreadcrumbs({ routes: Array<Route>, pathname: String }): Array<Breadcrumb>
 ```
 
----
-
-#### route
-
-Param | Type | Default | Required
---- | --- | --- | ---
-path | String | null | Required
-breadcrumb | String or Function (component) | null | Required
-matchOptions | Object | { exact: true } | Optional
-
----
-
-#### getBreadcrumbs
-If you don't want to use the HOC the `getBreadcrumbs` method is available to use instead.
-
-```js
-import { getBreadcrumbs } from 'react-router-breadcrumbs-hoc';
-
-getBreadcrumbs({
-  routes,
-  pathname,
-}): breadcrumbs: Array<object> { breadcrumb, path, match }
-```
-
-
 ### Thanks
 - [Koan Inc.](https://koan.co)
 - [rjz](https://github.com/rjz)