Skip to content

Commit

Permalink
Added a README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Robert Whitaker committed May 29, 2015
1 parent f4556d4 commit 854ff97
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Elm-Planner
A recursive planner application written in [Elm](http://elm-lang.org).

Just want to use it? [Try it out now!](http://robwhitaker.github.io/Elm-Planner)

## Features
* Take notes in a tree-hierarchy, allowing each node to have sub-nodes down to any depth.
* Each node can be titled and can store text content of its own (including nodes with children).
* Autosave as you go! Every change you make is automatically saved to localstorage.
* Save projects to or load project from your local machine. Working from multiple computers or browsers? Save the file, transfer it to your other machine, and upload it right back into Elm Planner!

## Building Locally

This is assuming you have Elm v0.15+ installed already. If not, get it [here](http://elm-lang.org).

1. Clone this repository.
2. In terminal:
```
$ cd PATH_TO_ELM_PLANNER
$ elm-package install -y
$ ./make && elm reactor
```
3. Open `localhost:8000/index.html` in your browser.

0 comments on commit 854ff97

Please sign in to comment.