Skip to content

Commit 847cf6e

Browse files
committed
Updated README
1 parent 8067404 commit 847cf6e

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
# purescript-wire-react-router
22

3-
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.
3+
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.
44

55
```purescript
66
makeRouter ::
77
forall route f.
88
Foldable f =>
99
PushStateInterface ->
10-
{ fallback :: route
11-
, parse :: String -> f route
10+
{ parse :: String -> f route
1211
, print :: route -> String
1312
, onRoute :: route -> Router route Transitioning Resolved Unit
13+
, onTransition :: Transition route -> Effect Unit
1414
} ->
1515
Effect
16-
{ signal :: Signal (Route route)
17-
, component :: JSX
16+
{ component :: JSX
1817
, navigate :: route -> Effect Unit
1918
, redirect :: route -> Effect Unit
2019
}

0 commit comments

Comments
 (0)