~alcinnz/bureaucromancy

f80f12fd2b4a73c763839304080ee7e3ddc7ab77 — Adrian Cochrane 3 months ago 42227cb master
Clarify how to run, release 0.1.0.2
3 files changed, 5 insertions(+), 2 deletions(-)

M README.md
M app/Main.hs
M bureaucromancy.cabal
M README.md => README.md +3 -1
@@ 12,4 12,6 @@

Bureaucromancy is a module for parsing webforms out of webpages with the aid of XML-Conduit or HTML-Conduit. This aids rendering these forms independently of the rest of the page, with support for hypertext rendering built-in.

Run `cabal run bureaucromancy form.html` to run a local serverside webapp facilitate entering data into the first webform found in the HTML file `form.html`. Run `cabal test` to verify that forms are parsed correctly from an XML-Conduit Document.
Run `cabal run bureaucromancy form.html` to run a local serverside webapp facilitate entering data into the first webform found in the HTML file `form.html`, serving from http://localhost:2018/ .

As a UI-centric component, a test-suite hasn't been implemented yet. It hasn't been prioritized due to the ease of manual testing.

M app/Main.hs => app/Main.hs +1 -0
@@ 26,6 26,7 @@ main = do
        [] -> ("form.html", "0")
  doc <- HTML.readFile filename
  let form = ensureButtons $ fromJust $ parseDocument doc $ Txt.pack ident
  putStrLn "http://127.0.0.1:2018/"
  runEnv 2018 $ servePage form

servePage :: Form -> Application

M bureaucromancy.cabal => bureaucromancy.cabal +1 -1
@@ 20,7 20,7 @@ name:               bureaucromancy
-- PVP summary:     +-+------- breaking API changes
--                  | | +----- non-breaking API additions
--                  | | | +--- code changes with no API change
version:            0.1.0.1
version:            0.1.0.2

-- A short (one-line) description of the package.
synopsis:           Parse webforms & render to interactive hypertext