Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
robertdp committed Oct 19, 2020
1 parent 8067404 commit 847cf6e
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
}
Expand Down

0 comments on commit 847cf6e

Please sign in to comment.