mirror of
https://github.com/ryannhg/elm-spa.git
synced 2024-11-22 01:32:43 +03:00
update readme
This commit is contained in:
parent
4d015a2faf
commit
0a9b905a4b
18
README.md
18
README.md
@ -17,4 +17,20 @@ elm install ryannhg/elm-spa
|
||||
|
||||
```
|
||||
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!
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user