Skip to content

Commit

Permalink
Administrative. Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
HeinrichApfelmus committed Sep 7, 2013
1 parent 9bc7993 commit e975ff6
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Use the web browser as a GUI, controllable from Haskell.
Threepenny-gui is a GUI framework that uses the web browser as a display.

* [Project homepage](http://www.haskell.org/haskellwiki/Threepenny-gui)

## Introduction

Expand All @@ -12,8 +14,8 @@ What is more, Threepenny is controlled entirely from within Haskell code,
relieving the user of writing client-side Javascript by hand.

Threepenny comes with a simple web server that is preconfigured to host a
client-side JS file called threepenny-gui.js. The Threepenny API communicates
with this JS to create new elements, respond to events, and more. This frequent
client-side JS file called `threepenny-gui.js`. The Threepenny API communicates
with this JS to create new elements, respond to events, and more. This frequent
communication precludes Threepenny from use in high-latency environments.

Users can, however, write their own Javascript if they wish, and invoke that
Expand Down Expand Up @@ -87,3 +89,17 @@ can read the pages.

There are plenty more like this, but this is the first that springs to
mind that is good.

## Contributors

Many thanks to everyone who contributed, provided feedback or simply wrote an application using Threepenny!

* *Heinrich Apfelmus*
* *Daniel Austin*
* Daniel Díaz
* *Daniel Mlot*
* Luke Palmer
* Jens Petersen
* rnons

Special thanks to *Chris Done* for starting the precursor project Ji.
6 changes: 4 additions & 2 deletions src/Reactive/Threepenny.hs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ module Reactive.Threepenny (

-- * IO
-- | Functions to connect events to the outside world.
Handler, newEvent, newEventsNamed, register,
Handler, newEvent, register,
currentValue,

-- * Core Combinators
Expand All @@ -36,7 +36,9 @@ module Reactive.Threepenny (
-- $recursion

-- * Internal
onChange, unsafeMapIO,
-- | Functions reserved for special circumstances.
-- Do not use unless you know what you're doing.
onChange, unsafeMapIO, newEventsNamed,
) where

import Control.Applicative
Expand Down
5 changes: 2 additions & 3 deletions threepenny-gui.cabal
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Name: threepenny-gui
Version: 0.3.0.0
Synopsis: Small GUI framework that uses the web browser as a display.
Synopsis: GUI framework that uses the web browser as a display.
Description:
Threepenny-GUI is a small GUI framework that uses the web browser as a display.
Threepenny-GUI is a GUI framework that uses the web browser as a display.
.
It's cheap and easy to install because everyone has a web browser installed.
.
Expand All @@ -12,7 +12,6 @@ Description:
from your Haskell code.
.
Stability forecast: This is an experimental release! Send us your feedback!
Basic functionality should work.
Significant API changes are likely in future versions.
.
NOTE: This library contains examples, but they are not built by default.
Expand Down

0 comments on commit e975ff6

Please sign in to comment.