diff --git a/README.md b/README.md index 3e2a382..0c0c2c8 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,19 @@ # purescript-wire-react-router -A basic pushstate router for React, with support for asynchronous routing logic. Built using [react-basic-hooks](https://github.com/spicydonuts/purescript-react-basic-hooks) and [wire](https://github.com/robertdp/purescript-wire). I recommend [routing-duplex](https://github.com/natefaubion/purescript-routing-duplex) for easy parsing and printing. +A basic pushstate router for React with support for asynchronous routing logic, built using [react-basic-hooks](https://github.com/spicydonuts/purescript-react-basic-hooks). I recommend [routing-duplex](https://github.com/natefaubion/purescript-routing-duplex) for easy parsing and printing and [wire](https://github.com/robertdp/purescript-wire) for easy reactive state. ```purescript makeRouter :: forall route f. Foldable f => PushStateInterface -> - { fallback :: route - , parse :: String -> f route + { parse :: String -> f route , print :: route -> String , onRoute :: route -> Router route Transitioning Resolved Unit + , onTransition :: Transition route -> Effect Unit } -> Effect - { signal :: Signal (Route route) - , component :: JSX + { component :: JSX , navigate :: route -> Effect Unit , redirect :: route -> Effect Unit }