Skip to content

Commit 37ffed7

Browse files
committed
Create README.md
1 parent d2b65ee commit 37ffed7

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# elm-impress
2+
A port of [impress.js](https://github.com/impress/impress.js) by [@bartaz](https://github.com/bartaz) to [Elm](elm-lang.org)
3+
4+
## Status
5+
The software is usable.
6+
It is as simple as creating a declarative list of *steps* in a separate Elm file, wiring it up in the `Main` module.
7+
In Elm terms, each step is defined as a [record type](http://elm-lang.org/guide/core-language#records) with default values,
8+
and ends up being turned into an [`Html`](https://github.com/evancz/elm-html) type by the `elm-impress` engine.
9+
10+
See the `Demo` folder for an example, taken from [the official impress.js demo](http://impress.github.io/impress.js).
11+
12+
## ToDo
13+
- [ ] Provide more details on usage
14+
- [ ] Describe differences vs. the original JavaScript version (very few indeed, and minor too)

0 commit comments

Comments
 (0)