diff --git a/README.md b/README.md index 1afd0b1176b2905ece98c1169637c98a74ae5c9a..5ec1a3ec961a58207ea8df7433e6a8a58288a18f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,19 @@ # Hikaru -**Haskell web micro framework** +**Hikaru is a micro framework for web applications. It provides applicative routing, content negotiation and a customizable action monad.** -Hikaru (light in Japanese, also first name of helmsman Sulu of the Enterprise) is a micro framework for web applications. It provides applicative routing, content negotiation and a customizable action monad. +(It is also a Star Trek reference, which is apparently a requirement for this class of software.) + + +## Usage + +- Start with the [Simple.hs], an example application. + +- Check out the generated reference [documentation][]. + + +[Simple.hs]: https://github.com/mordae/hikaru/tree/master/examples/Simple.hs +[documentation]: http://hackage.haskell.org/package/hikaru <!-- vim:set spell spelllang=cs,en: --> diff --git a/hikaru.cabal b/hikaru.cabal index 25d480d9abcd093ce424e668e534a0a3c6668a54..41bcc5c547dad1924a939f0fbdb343775988c1b8 100644 --- a/hikaru.cabal +++ b/hikaru.cabal @@ -2,14 +2,17 @@ -- -- see: https://github.com/sol/hpack -- --- hash: 3f6987dad8453f38f554917a82b846a8e83799e9a36b3c5ab8035db2ff53715d +-- hash: 080de386f6ba22ecc810a0d7c402cafe3f478f868743a1cf4d032526533ec874 name: hikaru version: 0.1.0.0 synopsis: Haskell web micro framework -description: Hikaru (light in Japanese, also first name of helmsman Sulu of the Enterprise) - is a micro framework for web applications. It provides applicative routing, - content negotiation and a customizable action monad. +description: Hikaru is a micro framework for web applications. + It provides applicative routing, content negotiation + and a customizable action monad. + . + (It is also a Star Trek reference, which is apparently + a requirement for this class of software.) category: Web homepage: https://github.com/mordae/hikaru#readme bug-reports: https://github.com/mordae/hikaru/issues diff --git a/package.yaml b/package.yaml index e2e48a5f820559a279c3ad34833eaf773bc2d4f5..12680f4d8f5acb895a12084f18cbcbe3714213f2 100644 --- a/package.yaml +++ b/package.yaml @@ -3,9 +3,12 @@ version: 0.1.0.0 synopsis: Haskell web micro framework category: Web description: | - Hikaru (light in Japanese, also first name of helmsman Sulu of the Enterprise) - is a micro framework for web applications. It provides applicative routing, - content negotiation and a customizable action monad. + Hikaru is a micro framework for web applications. + It provides applicative routing, content negotiation + and a customizable action monad. + + (It is also a Star Trek reference, which is apparently + a requirement for this class of software.) author: Jan Hamal Dvořák github: mordae/hikaru