From 2f3b68db4ceb0f79c4dd4e958b1c343d8c160730 Mon Sep 17 00:00:00 2001 From: Ryan Haskell-Glatz Date: Fri, 15 Jan 2021 21:51:12 -0600 Subject: [PATCH] update readme --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1bbad3b..c6ca494 100644 --- a/README.md +++ b/README.md @@ -13,4 +13,29 @@ __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. \ No newline at end of file +__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 +```