From 35e68d11c101f0b9b8c432c5a0ac213d1148d6fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Hamal=20Dvo=C5=99=C3=A1k?= <mordae@anilinux.org> Date: Tue, 30 Apr 2019 22:57:44 +0200 Subject: [PATCH] Improve the description MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jan Hamal Dvořák <mordae@anilinux.org> --- README.md | 15 +++++++++++++-- hikaru.cabal | 11 +++++++---- package.yaml | 9 ++++++--- 3 files changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1afd0b1..5ec1a3e 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 25d480d..41bcc5c 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 e2e48a5..12680f4 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 -- GitLab