mirror of
https://github.com/ryan-haskell/elm-spa.git
synced 2024-11-29 09:31:20 +03:00
update readme
This commit is contained in:
parent
b2cf688ae0
commit
2f3b68db4c
25
README.md
25
README.md
@ -14,3 +14,28 @@ __Visit the official site__ at [elm-spa.dev](https://v6.elm-spa.dev) for more ex
|
||||
## **The Elm package**
|
||||
|
||||
__If you are using elm-spa__, there's no read through the [Elm package](https://package.elm-lang.org/packages/ryannhg/elm-spa/6.0.0/) documentation. The package exists to constrain the CLI, and serves as a reference for future contributions.
|
||||
|
||||
# **At a glance**
|
||||
|
||||
## **1. Create a new project**
|
||||
|
||||
```bash
|
||||
mkdir your-new-app
|
||||
cd your-new-app
|
||||
elm-spa new
|
||||
```
|
||||
|
||||
## **2. Check out the new files**
|
||||
|
||||
```bash
|
||||
your-elm-app/
|
||||
- elm.json
|
||||
- src/Pages/Home_.elm
|
||||
- public/index.html
|
||||
```
|
||||
|
||||
## **3. Run it in your browser**
|
||||
|
||||
```bash
|
||||
elm-spa server # Ready at http://localhost:1234
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user