Documentation

Changelog

@@ -1,3 +1,12 @@
 v 1.0
 =====
 Initial release
+
+v3.0
+====
+New release, powered by servant
+- Side by side input and output
+- Form submitted via ajax
+- httpie and curl samples
+
+

README.md

@@ -1,12 +1,29 @@
 quickwebapp
 ===========
-A quick-and-dirty api generator, for any function `a -> b` which can be wrapped
-inside a function `ByteString -> ByteString`.
-It is inspired from the 'interact' function from 'Prelude'.
+A quick-and-dirty api generator, for any function `a -> Either String b`.
+
+It is inspired from the `interact` function from the Prelude.
 
 ~~~{haskell}
-interactWeb reverse
+interactWeb (reverse :: String -> String)
+~~~
+
+This creates a server listening on port 8080. You can change the port with the `PORT` env variable.
+
+You can query it via a browser at <http://localhost:8080> or by using
+curl/httpie
+
+httpie
+------
+
+~~~{bash}
+http :8080 input="<your input string>"
 ~~~
 
-This creates a server listening on port 3000.
+curl
+----
+
+~~~{bash}
+curl localhost:8080 -d input="<your input string>"
+~~~
 

default.nix

@@ -3,7 +3,7 @@
 }:
 mkDerivation {
   pname = "quickwebapp";
-  version = "3.0.0.1";
+  version = "3.0.0.2";
   src = ./.;
   libraryHaskellDepends = [
     aeson base bytestring containers either lucid servant servant-lucid

quickwebapp.cabal

@@ -1,5 +1,5 @@
 name:                quickwebapp
-version:             3.0.0.1
+version:             3.0.0.2
 synopsis:            A quick webapp generator for any file processing tool
 description:
     A quick-and-dirty api generator, inspired from the 'interact' function from
@@ -15,7 +15,7 @@ author:              Julien Tanguy
 maintainer:          [email protected]
 category:            Web
 build-type:          Simple
-extra-source-files:  Changelog
+extra-source-files:  Changelog, README.md
 cabal-version:       >=1.10
 
 bug-reports: https://github.com/jtanguy/quickwebapp/issues