search

rgrempel / elm-route-url

Router for single-page-apps in Elm
http://package.elm-lang.org/packages/rgrempel/elm-route-url/latest
MIT License
196 stars 16 forks source link

Documentation lacking how to parse Location with Builder #18

Open yotamDvir opened 8 years ago

yotamDvir commented 8 years ago

In the docs, I couldn't find the Location type alias.

Furthermore, the docs say that the Builder can help with parsing the Location, but not a single function has Location in its signature.

Although it only took a few minutes to find such functions in the example, in my opinion the docs should define the Location type alias and be explicit about its intended use with the Builder, for people like me who never used routing before stumbling upon this library.

rgrempel commented 8 years ago

Thanks, the documentation should indeed be better on these points -- I'll work on it.

sethlivingston commented 6 years ago

This is a terrific library; thank you for building it. The code you've written in the examples folder is well written, but it obfuscates how to use your library. It would be great if the README had basic examples for how to use the new API to route URLs and how to use the new API to route hashes.