Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tetotechy committed Oct 9, 2015
1 parent d2b65ee commit 37ffed7
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# elm-impress
A port of [impress.js](https://github.com/impress/impress.js) by [@bartaz](https://github.com/bartaz) to [Elm](elm-lang.org)

## Status
The software is usable.
It is as simple as creating a declarative list of *steps* in a separate Elm file, wiring it up in the `Main` module.
In Elm terms, each step is defined as a [record type](http://elm-lang.org/guide/core-language#records) with default values,
and ends up being turned into an [`Html`](https://github.com/evancz/elm-html) type by the `elm-impress` engine.

See the `Demo` folder for an example, taken from [the official impress.js demo](http://impress.github.io/impress.js).

## ToDo
- [ ] Provide more details on usage
- [ ] Describe differences vs. the original JavaScript version (very few indeed, and minor too)

0 comments on commit 37ffed7

Please sign in to comment.