From 346f6cdd93806468bf8e24eab787433f1bb9ab94 Mon Sep 17 00:00:00 2001 From: Katrina Owen Date: Wed, 25 Nov 2015 09:24:04 -0700 Subject: [PATCH] Add docs in support of x-api v3 --- config.json | 3 ++- docs/INSTALLATION.md | 8 ++++++++ docs/TESTS.md | 16 ++++++++++++++++ 3 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/INSTALLATION.md create mode 100644 docs/TESTS.md diff --git a/config.json b/config.json index 7cb670a..3fb1036 100644 --- a/config.json +++ b/config.json @@ -11,7 +11,8 @@ ], "ignored": [ - "bin" + "bin", + "docs" ], "foregone": [ diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md new file mode 100644 index 0000000..ee2daa9 --- /dev/null +++ b/docs/INSTALLATION.md @@ -0,0 +1,8 @@ +Download and install a recent Elm Platform for your OS from [elm-lang.org/install](http://elm-lang.org/install). + +## MacOS + +```bash +$ npm install --global elm +$ elm-package install -y +``` diff --git a/docs/TESTS.md b/docs/TESTS.md new file mode 100644 index 0000000..e159eb1 --- /dev/null +++ b/docs/TESTS.md @@ -0,0 +1,16 @@ +First, execute the following: +```bash +$ elm-reactor +``` +Then go to `localhost:8000` in your browser and navigate to your test file. + +## Making Your First Elm Module + +To create a module that can be loaded with `import BobExample exposing (responseFor)`, put this code in `BobExample.elm`: + +```elm +module BobExample where + +responseFor : String -> String +responseFor statement = undefined +```