Doc link updates
commit50d7a20ca31b9ff36b208ac2cb343c0821a93b25
authorMichael Snoyman <michael@snoyman.com>
dateSun 21 Dec 2014, 11:27 (12 years ago)
parent14a2047
auto-update/changelog.md → auto-update/ChangeLog.mdrenamed
The content is the same.
auto-update/README.md+11−3
@@ -1,5 +1,13 @@
1−See https://github.com/yesodweb/yesod-scaffold/pull/15
1+## auto-update
22
3−Todo:
3+A common problem is the desire to have an action run at a scheduled interval,
4+but only if it is needed. For example, instead of having every web request
5+result in a new 1getCurrentTime1 call, we'd like to have a single worker thread
6+run every second, updating an 1IORef1. However, if the request frequency is
7+less than once per second, this is a pessimization, and worse, kills idle GC.
48
5−- Add ThreadId to prevent race condition.
9+This library allows you to define actions which will either be performed by a
10+dedicated thread or, in times of low volume, will be executed by the calling
11+thread.
12+
13+For original use case, see [yesod-scaffold issue #15](https://github.com/yesodweb/yesod-scaffold/pull/15).
auto-update/auto-update.cabal+3−6
@@ -1,10 +1,7 @@
11name: auto-update
2−version: 0.1.2
2+version: 0.1.2.1
33synopsis: Efficiently run periodic, on-demand actions
4−description:
5− A common problem is the desire to have an action run at a scheduled interval, but only if it is needed. For example, instead of having every web request result in a new @getCurrentTime@ call, we'd like to have a single worker thread run every second, updating an @IORef@. However, if the request frequency is less than once per second, this is a pessimization, and worse, kills idle GC.
6− .
7− This library allows you to define actions which will either be performed by a dedicated thread or, in times of low volume, will be executed by the calling thread.
4+description: API docs and the README are available at <http://www.stackage.org/package/auto-update>.
85homepage: https://github.com/yesodweb/wai
96license: MIT
107license-file: LICENSE
@@ -13,7 +10,7 @@ maintainer: michael@snoyman.com
1310category: Control
1411build-type: Simple
1512extra-source-files: README.md
16− changelog.md
13+ ChangeLog.md
1714cabal-version: >=1.10
1815
1916library
mime-types/ChangeLog.mdnew file+1
@@ -0,0 +1 @@
1+No changes logged yet
mime-types/README.mdnew file+3
@@ -0,0 +1,3 @@
1+## mime-types
2+
3+Basic mime-type handling types and functions
mime-types/mime-types.cabal+3−2
@@ -1,7 +1,7 @@
11name: mime-types
2−version: 0.1.0.4
2+version: 0.1.0.5
33synopsis: Basic mime-type handling types and functions
4−description: Basic mime-type handling types and functions
4+description: API docs and the README are available at <http://www.stackage.org/package/mime-types>.
55homepage: https://github.com/yesodweb/wai
66license: MIT
77license-file: LICENSE
@@ -10,6 +10,7 @@ maintainer: michael@snoyman.com
1010category: Web
1111build-type: Simple
1212cabal-version: >=1.8
13+extra-source-files: README.md ChangeLog.md
1314
1415library
1516 exposed-modules: Network.Mime
wai-app-static/wai-app-static.cabal+2−2
@@ -1,11 +1,11 @@
11name: wai-app-static
2−version: 3.0.0.4
2+version: 3.0.0.5
33license: MIT
44license-file: LICENSE
55author: Michael Snoyman <michael@snoyman.com>
66maintainer: Michael Snoyman <michael@snoyman.com>, Greg Weber <greg@gregweber.info>
77synopsis: WAI application for static serving
8−description: Hackage documentation generation is not reliable. For up to date documentation, please see: <http://www.stackage.org/package/wai-app-static>.
8+description: API docs and the README are available at <http://www.stackage.org/package/wai-app-static>.
99category: Web, Yesod
1010stability: Stable
1111cabal-version: >= 1.8
wai-conduit/ChangeLog.mdnew file+1
@@ -0,0 +1 @@
1+No changes logged yet.
wai-conduit/README.mdnew file+4
@@ -0,0 +1,4 @@
1+## wai-conduit
2+
3+Since version 3.0.0, WAI has no built-in streaming data abstraction. This
4+library provides similar functionality to what existed in WAI 2.x.
wai-conduit/wai-conduit.cabal+3−3
@@ -1,8 +1,7 @@
11name: wai-conduit
2−version: 3.0.0.1
2+version: 3.0.0.2
33synopsis: conduit wrappers for WAI
4−description: Since version 3.0.0, WAI has no built-in streaming data abstraction.
5− This library provides similar functionality to what existed in WAI 2.x.
4+description: API docs and the README are available at <http://www.stackage.org/package/wai-conduit>.
65homepage: https://github.com/yesodweb/wai
76license: MIT
87license-file: LICENSE
@@ -11,6 +10,7 @@ maintainer: michael@snoyman.com
1110category: Web, Conduit
1211build-type: Simple
1312cabal-version: >=1.10
13+extra-source-files: README.md ChangeLog.md
1414
1515library
1616 exposed-modules: Network.Wai.Conduit
wai-extra/READMEdeleted−1
@@ -1 +0,0 @@
1−Provides some basic WAI handlers and middleware.
wai-extra/wai-extra.cabal+2−2
@@ -1,7 +1,7 @@
11Name: wai-extra
2−Version: 3.0.3
2+Version: 3.0.3.1
33Synopsis: Provides some basic WAI handlers and middleware.
4−Description: The goal here is to provide common features without many dependencies.
4+description: API docs and the README are available at <http://www.stackage.org/package/wai-extra>.
55License: MIT
66License-file: LICENSE
77Author: Michael Snoyman
wai-frontend-monadcgi/ChangeLog.mdnew file+1
@@ -0,0 +1 @@
1+No changes logged yet.
wai-frontend-monadcgi/READMEdeleted−1
@@ -1 +0,0 @@
1−Run CGI apps on WAI handlers.
wai-frontend-monadcgi/README.mdnew file+5
@@ -0,0 +1,5 @@
1+## wai-frontend-monadcgi
2+
3+Allows programs written against MonadCGI to run with any WAI handler. This is
4+most useful for running your existing CGI apps on Warp. For true "yo
5+dawg"-ness, try running this through the WAI CGI backend.
wai-frontend-monadcgi/wai-frontend-monadcgi.cabal+2−1
@@ -5,11 +5,12 @@ license-file: LICENSE
55author: Michael Snoyman <michael@snoyman.com>
66maintainer: Michael Snoyman <michael@snoyman.com>
77synopsis: Run CGI apps on WAI.
8−description: Allows programs written against MonadCGI to run with any WAI handler. This is most useful for running your existing CGI apps on Warp. For true "yo dawg"-ness, try running this through the WAI CGI backend.
8+description: API docs and the README are available at <http://www.stackage.org/package/wai-frontend-monadcgi>.
99category: Web
1010stability: stable
1111cabal-version: >= 1.6
1212build-type: Simple
13+extra-source-files: README.md ChangeLog.md
1314
1415library
1516 build-depends: base >= 4 && < 5
wai-handler-fastcgi/ChangeLog.mdnew file+1
@@ -0,0 +1 @@
1+No changes logged yet.
wai-handler-fastcgi/README.mdnew file+3
@@ -0,0 +1,3 @@
1+## wai-handler-fastcgi
2+
3+Calls out to the libfcgi C library.
wai-handler-fastcgi/wai-handler-fastcgi.cabal+3−3
@@ -1,17 +1,17 @@
11name: wai-handler-fastcgi
2−version: 3.0.0
2+version: 3.0.0.1
33license: MIT
44license-file: LICENSE
55author: Michael Snoyman <michael@snoyman.com>
66maintainer: Michael Snoyman <michael@snoyman.com>
77synopsis: Wai handler to fastcgi
8+description: API docs and the README are available at <http://www.stackage.org/package/wai-handler-fastcgi>.
89category: Web
910stability: stable
1011cabal-version: >= 1.6
1112build-type: Configure
12−extra-source-files: configure fastcgi.buildinfo.in
13+extra-source-files: configure fastcgi.buildinfo.in README.md ChangeLog.md
1314homepage: http://www.yesodweb.com/book/web-application-interface
14−description: Calls out to the libfcgi C library.
1515
1616library
1717 build-depends: base >= 4 && < 5
wai-handler-launch/ChangeLog.mdnew file+1
@@ -0,0 +1 @@
1+No changes logged yet
wai-handler-launch/README.mdnew file+4
@@ -0,0 +1,4 @@
1+## wai-handler-launch
2+
3+This handles cross-platform launching and inserts Javascript code to ping the
4+server. When the server no longer receives pings, it shuts down.
wai-handler-launch/wai-handler-launch.cabal+3−2
@@ -1,7 +1,7 @@
11Name: wai-handler-launch
2−Version: 3.0.0
2+Version: 3.0.0.1
33Synopsis: Launch a web app in the default browser.
4−Description: This handles cross-platform launching and inserts Javascript code to ping the server. When the server no longer receives pings, it shuts down.
4+description: API docs and the README are available at <http://www.stackage.org/package/wai-handler-launch>.
55License: MIT
66License-file: LICENSE
77Author: Michael Snoyman
@@ -9,6 +9,7 @@ Maintainer: michael@snoyman.com
99Category: Web
1010Build-type: Simple
1111Cabal-version: >=1.6
12+extra-source-files: README.md ChangeLog.md
1213
1314Library
1415 Exposed-modules: Network.Wai.Handler.Launch
wai-handler-webkit/ChangeLog.mdnew file+1
@@ -0,0 +1 @@
1+No changes logged yet
wai-handler-webkit/wai-handler-webkit.cabal+3−4
@@ -1,18 +1,17 @@
11name: wai-handler-webkit
2−version: 3.0.0
2+version: 3.0.0.1
33license: MIT
44license-file: LICENSE
55author: Michael Snoyman <michael@snoyman.com>
66maintainer: Michael Snoyman <michael@snoyman.com>
77synopsis: Turn WAI applications into standalone GUIs using QtWebkit.
8−description: Runs any WAI application using
9− the simpleserver handler and then pops up a Webkit browser
10− to view it.
8+description: API docs and the README are available at <http://www.stackage.org/package/wai-handler-webkit>.
119category: Web
1210stability: unstable
1311cabal-version: >= 1.6
1412build-type: Simple
1513homepage: https://github.com/yesodweb/wai/tree/master/wai-handler-webkit
14+extra-source-files: README.md ChangeLog.md
1615
1716library
1817 build-depends: base >= 4 && < 5
wai-websockets/ChangeLog.mdnew file+1
@@ -0,0 +1 @@
1+No changes logged yet.
wai-websockets/README.mdnew file+3
@@ -0,0 +1,3 @@
1+## wai-websockets
2+
3+Use websockets with WAI applications, primarily those hosted via Warp.
wai-websockets/wai-websockets.cabal+3−2
@@ -1,5 +1,5 @@
11Name: wai-websockets
2−Version: 3.0.0.2
2+Version: 3.0.0.3
33Synopsis: Provide a bridge betweeen WAI and the websockets package.
44License: MIT
55License-file: LICENSE
@@ -10,9 +10,10 @@ Category: Web, Yesod
1010Build-Type: Simple
1111Cabal-Version: >=1.8
1212Stability: Stable
13−Description: This is primarily intended for use with Warp and its settingsIntercept.
13+description: API docs and the README are available at <http://www.stackage.org/package/wai-websockets>.
1414
1515extra-source-files: static/client.js, static/client.html, static/screen.css
16+ README.md ChangeLog.md
1617
1718flag example
1819
wai/ChangeLog.mdnew file+1
@@ -0,0 +1 @@
1+No changes logged yet.
wai/wai.cabal+3−1
@@ -1,7 +1,8 @@
11Name: wai
2−Version: 3.0.2
2+Version: 3.0.2.1
33Synopsis: Web Application Interface.
44Description: Provides a common protocol for communication between web applications and web servers.
5+description: API docs and the README are available at <http://www.stackage.org/package/wai>.
56License: MIT
67License-file: LICENSE
78Author: Michael Snoyman
@@ -11,6 +12,7 @@ Category: Web
1112Build-Type: Simple
1213Cabal-Version: >=1.8
1314Stability: Stable
15+extra-source-files: README.md ChangeLog.md
1416
1517Source-repository head
1618 type: git
warp-tls/README.md+4
@@ -1,3 +1,7 @@
1+## warp-tls
2+
3+Serve WAI applications using the Warp webserver and the Haskell TLS library.
4+
15In order to generate a self-signed certificate for testing, try the following:
26
37 openssl genrsa -out key.pem 2048
warp-tls/warp-tls.cabal+3−3
@@ -1,5 +1,5 @@
11Name: warp-tls
2−Version: 3.0.1
2+Version: 3.0.1.1
33Synopsis: HTTP over SSL/TLS support for Warp via the TLS package
44License: MIT
55License-file: LICENSE
@@ -10,8 +10,8 @@ Category: Web, Yesod
1010Build-Type: Simple
1111Cabal-Version: >=1.6
1212Stability: Stable
13−Description: HTTP over SSL/TLS support for Warp via the TLS package.
14−extra-source-files: ChangeLog.md
13+description: API docs and the README are available at <http://www.stackage.org/package/warp-tls>.
14+extra-source-files: ChangeLog.md README.md
1515
1616Library
1717 Build-Depends: base >= 4 && < 5
warp/README.md+2
@@ -1,2 +1,4 @@
1+## warp
2+
13The premier WAI handler. For more information, see [Warp: A Haskell Web
24Server](http://steve.vinoski.net/blog/2011/05/01/warp-a-haskell-web-server/).
warp/warp.cabal+2−2
@@ -1,5 +1,5 @@
11Name: warp
2−Version: 3.0.4
2+Version: 3.0.4.1
33Synopsis: A fast, light-weight web server for WAI applications.
44License: MIT
55License-file: LICENSE
@@ -10,7 +10,7 @@ Category: Web, Yesod
1010Build-Type: Simple
1111Cabal-Version: >=1.8
1212Stability: Stable
13−Description: The premier WAI handler. For more information, see <http://steve.vinoski.net/blog/2011/05/01/warp-a-haskell-web-server/>.
13+description: API docs and the README are available at <http://www.stackage.org/package/warp>.
1414extra-source-files: attic/hex
1515 ChangeLog.md
1616 README.md