ryannhg/elm-spa
1
1
Fork 0
mirror of https://github.com/ryannhg/elm-spa.git synced 2024-11-22 17:52:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Ryan Haskell-Glatz 2020-03-26 23:46:52 -05:00
parent 4d015a2faf
commit 0a9b905a4b
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -18,3 +18,19 @@ elm install ryannhg/elm-spa
``` ```
cd example && npm start cd example && npm start
``` ```
### overview
When you create an app with the [elm/browser](https://package.elm-lang.org/packages/elm/browser/latest) package, you can build anything from a static `Html msg` page to a fully-fledged web `Browser.application`.
`elm-spa` uses that design at the page-level, so you can quickly add new pages to your Elm application!
## the four kinds of pages:
1. __static__ – a page that only renders HTML.
2. __sandbox__ – a page with state.
3. __element__ – a page with side-effects.
4. __component__ – a page with global state.
Check out [the package docs](https://package.elm-lang.org/packages/ryannhg/elm-spa/latest/Spa) to learn more!