diff --git a/README.md b/README.md index ae657b6..bef5bd2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # purs-architecture-tutorial A port of the [Elm Architecture Tutorial](https://github.com/evancz/elm-architecture-tutorial/) to PureScript. + +## Getting Started: + +1. Ensure that you've got PureScript 0.7.4.1 installed. +2. Ensure that you've got pulp installed. +3. Run `npm install` to get the virtual-dom dependency loaded +4. Run `pulp dep install` to get the PureScript dependencies loaded +5. Run `pulp server` to run the server and access it at `http://localhost:1337` diff --git a/package.json b/package.json new file mode 100644 index 0000000..1fe5fcd --- /dev/null +++ b/package.json @@ -0,0 +1,26 @@ +{ + "name": "purs-architecture-tutorial", + "version": "1.0.0", + "description": "A port of the [Elm Architecture Tutorial](https://github.com/evancz/elm-architecture-tutorial/) to PureScript.", + "main": "index.js", + "directories": { + "test": "test" + }, + "dependencies": { + "virtual-dom": "^2.1.1" + }, + "devDependencies": {}, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/parsonsmatt/purs-architecture-tutorial.git" + }, + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/parsonsmatt/purs-architecture-tutorial/issues" + }, + "homepage": "https://github.com/parsonsmatt/purs-architecture-tutorial#readme" +}