From bed6dafce8302e21e0f4f3bb6c053f3b10f0ebbf Mon Sep 17 00:00:00 2001 From: Michael Snoyman Date: Sun, 21 Dec 2014 15:23:52 +0200 Subject: [PATCH] Doc link updates --- .../README => yesod-auth-oauth/ChangeLog.md | 0 yesod-auth-oauth/README.md | 3 +++ yesod-auth-oauth/yesod-auth-oauth.cabal | 5 +++-- yesod-auth/README.md | 11 +++++++++++ yesod-auth/yesod-auth.cabal | 13 ++++--------- yesod-core/yesod-core.cabal | 4 ++-- yesod-eventsource/ChangeLog.md | 1 + yesod-eventsource/README.md | 16 ++++++++++++++++ yesod-eventsource/yesod-eventsource.cabal | 19 +++---------------- yesod-form/yesod-form.cabal | 4 ++-- .../README => yesod-newsfeed/ChangeLog.md | 0 yesod-newsfeed/README.md | 3 +++ yesod-newsfeed/yesod-newsfeed.cabal | 5 +++-- yesod-persistent/ChangeLog.md | 1 + yesod-persistent/README | 0 yesod-persistent/README.md | 3 +++ yesod-persistent/yesod-persistent.cabal | 5 +++-- .../README => yesod-sitemap/ChangeLog.md | 0 yesod-sitemap/README | 0 yesod-sitemap/README.md | 3 +++ yesod-sitemap/yesod-sitemap.cabal | 5 +++-- yesod-static/README | 0 yesod-static/README.md | 3 +++ yesod-static/yesod-static.cabal | 5 +++-- yesod-test/yesod-test.cabal | 4 ++-- yesod-websockets/ChangeLog.md | 1 + yesod-websockets/yesod-websockets.cabal | 4 +++- yesod/yesod.cabal | 4 ++-- 28 files changed, 78 insertions(+), 44 deletions(-) rename yesod-auth/README => yesod-auth-oauth/ChangeLog.md (100%) create mode 100644 yesod-auth-oauth/README.md create mode 100644 yesod-auth/README.md create mode 100644 yesod-eventsource/ChangeLog.md create mode 100644 yesod-eventsource/README.md rename yesod-form/README => yesod-newsfeed/ChangeLog.md (100%) create mode 100644 yesod-newsfeed/README.md create mode 100644 yesod-persistent/ChangeLog.md delete mode 100644 yesod-persistent/README create mode 100644 yesod-persistent/README.md rename yesod-newsfeed/README => yesod-sitemap/ChangeLog.md (100%) delete mode 100644 yesod-sitemap/README create mode 100644 yesod-sitemap/README.md delete mode 100644 yesod-static/README create mode 100644 yesod-static/README.md create mode 100644 yesod-websockets/ChangeLog.md diff --git a/yesod-auth/README b/yesod-auth-oauth/ChangeLog.md similarity index 100% rename from yesod-auth/README rename to yesod-auth-oauth/ChangeLog.md diff --git a/yesod-auth-oauth/README.md b/yesod-auth-oauth/README.md new file mode 100644 index 00000000..cb55c8ea --- /dev/null +++ b/yesod-auth-oauth/README.md @@ -0,0 +1,3 @@ +## yesod-auth-oauth + +Oauth Authentication for Yesod. diff --git a/yesod-auth-oauth/yesod-auth-oauth.cabal b/yesod-auth-oauth/yesod-auth-oauth.cabal index 7504e853..baead2c1 100644 --- a/yesod-auth-oauth/yesod-auth-oauth.cabal +++ b/yesod-auth-oauth/yesod-auth-oauth.cabal @@ -1,5 +1,5 @@ name: yesod-auth-oauth -version: 1.4.0 +version: 1.4.0.1 license: BSD3 license-file: LICENSE author: Hiromi Ishii @@ -10,7 +10,8 @@ stability: Stable cabal-version: >= 1.6.0 build-type: Simple homepage: http://www.yesodweb.com/ -description: Oauth Authentication for Yesod. +description: API docs and the README are available at +extra-source-files: README.md ChangeLog.md flag ghc7 diff --git a/yesod-auth/README.md b/yesod-auth/README.md new file mode 100644 index 00000000..e12c2e83 --- /dev/null +++ b/yesod-auth/README.md @@ -0,0 +1,11 @@ +## yesod-auth + +This package provides a pluggable mechanism for allowing users to authenticate +with your site. It comes with a number of common plugins, such as OpenID, +BrowserID (a.k.a., Mozilla Persona), and email. Other packages are available +from Hackage as well. If you've written such an add-on, please notify me so +that it can be added to this description. + +* [yesod-auth-account](http://hackage.haskell.org/package/yesod-auth-account): An account authentication plugin for Yesod +* [yesod-auth-hashdb](http://www.stackage.org/package/yesod-auth-hashdb): The HashDB module previously packaged in yesod-auth, now with stronger, but compatible, security. +* [yesod-auth-bcrypt](https://github.com/ollieh/yesod-auth-bcrypt/): An alternative to the HashDB module. diff --git a/yesod-auth/yesod-auth.cabal b/yesod-auth/yesod-auth.cabal index 45475a0b..1f14ab25 100644 --- a/yesod-auth/yesod-auth.cabal +++ b/yesod-auth/yesod-auth.cabal @@ -1,5 +1,5 @@ name: yesod-auth -version: 1.4.1 +version: 1.4.1.1 license: MIT license-file: LICENSE author: Michael Snoyman, Patrick Brisbin @@ -10,15 +10,10 @@ stability: Stable cabal-version: >= 1.6.0 build-type: Simple homepage: http://www.yesodweb.com/ -description: - This package provides a pluggable mechanism for allowing users to authenticate with your site. It comes with a number of common plugins, such as OpenID, BrowserID (a.k.a., Mozilla Persona), and email. Other packages are available from Hackage as well. If you've written such an add-on, please notify me so that it can be added to this description. - . - * : An account authentication plugin for Yesod - . - * : The HashDB module previously packaged in yesod-auth, now with stronger, but compatible, security. - . - * : An alternative to the HashDB module. +description: API docs and the README are available at extra-source-files: persona_sign_in_blue.png + README.md + ChangeLog.md flag network-uri description: Get Network.URI from the network-uri package diff --git a/yesod-core/yesod-core.cabal b/yesod-core/yesod-core.cabal index e16d1760..86ba5b31 100644 --- a/yesod-core/yesod-core.cabal +++ b/yesod-core/yesod-core.cabal @@ -1,11 +1,11 @@ name: yesod-core -version: 1.4.7 +version: 1.4.7.1 license: MIT license-file: LICENSE author: Michael Snoyman maintainer: Michael Snoyman synopsis: Creation of type-safe, RESTful web applications. -description: Hackage documentation generation is not reliable. For up to date documentation, please see: . +description: API docs and the README are available at category: Web, Yesod stability: Stable cabal-version: >= 1.8 diff --git a/yesod-eventsource/ChangeLog.md b/yesod-eventsource/ChangeLog.md new file mode 100644 index 00000000..58406890 --- /dev/null +++ b/yesod-eventsource/ChangeLog.md @@ -0,0 +1 @@ +No changes logged yet diff --git a/yesod-eventsource/README.md b/yesod-eventsource/README.md new file mode 100644 index 00000000..9a046552 --- /dev/null +++ b/yesod-eventsource/README.md @@ -0,0 +1,16 @@ +## yesod-eventsource + +It's easy to send an event from an HTTP client to a server: +just send an HTTP request. However, sending events from the +server to the client requires more sophisticated approaches. +[Server-sent events](http://www.w3.org/TR/eventsource/) are a +standardized way of pushing events from the server to the +client. + +This package allows your Yesod application to easily send +server-sent events. On the client side, you may use the +`EventSource` JavaScript object on browsers that support it +(https://developer.mozilla.org/en-US/docs/Server-sent_events/EventSource) +or a polyfill for browsers that don't (we support Remy's +polyfill out-of-the-box, although that requires you to +explicitly support it). diff --git a/yesod-eventsource/yesod-eventsource.cabal b/yesod-eventsource/yesod-eventsource.cabal index 6b0312f0..591bb6d7 100644 --- a/yesod-eventsource/yesod-eventsource.cabal +++ b/yesod-eventsource/yesod-eventsource.cabal @@ -1,5 +1,5 @@ name: yesod-eventsource -version: 1.4.0 +version: 1.4.0.1 license: MIT license-file: LICENSE author: Felipe Lessa @@ -10,21 +10,8 @@ stability: Stable cabal-version: >= 1.6 build-type: Simple homepage: http://www.yesodweb.com/ -description: - It's easy to send an event from an HTTP client to a server: - just send an HTTP request. However, sending events from the - server to the client requires more sophisticated approaches. - Server-sent events () are a - standardized way of pushing events from the server to the - client. - . - This package allows your Yesod application to easily send - server-sent events. On the client side, you may use the - @EventSource@ JavaScript object on browsers that support it - () - or a polyfill for browsers that don't (we support Remy's - polyfill out-of-the-box, although that requires you to - explicitly support it). +description: API docs and the README are available at +extra-source-files: README.md ChangeLog.md library build-depends: base >= 4 && < 5 diff --git a/yesod-form/yesod-form.cabal b/yesod-form/yesod-form.cabal index 858399c7..9d979f63 100644 --- a/yesod-form/yesod-form.cabal +++ b/yesod-form/yesod-form.cabal @@ -1,5 +1,5 @@ name: yesod-form -version: 1.4.3 +version: 1.4.3.1 license: MIT license-file: LICENSE author: Michael Snoyman @@ -10,7 +10,7 @@ stability: Stable cabal-version: >= 1.8 build-type: Simple homepage: http://www.yesodweb.com/ -description: Form handling support for Yesod Web Framework +description: API docs and the README are available at extra-source-files: ChangeLog.md README.md diff --git a/yesod-form/README b/yesod-newsfeed/ChangeLog.md similarity index 100% rename from yesod-form/README rename to yesod-newsfeed/ChangeLog.md diff --git a/yesod-newsfeed/README.md b/yesod-newsfeed/README.md new file mode 100644 index 00000000..51214c2e --- /dev/null +++ b/yesod-newsfeed/README.md @@ -0,0 +1,3 @@ +## yesod-newsfeed + +Helper functions and data types for producing News feeds. diff --git a/yesod-newsfeed/yesod-newsfeed.cabal b/yesod-newsfeed/yesod-newsfeed.cabal index 215fdfba..8ff7ed2b 100644 --- a/yesod-newsfeed/yesod-newsfeed.cabal +++ b/yesod-newsfeed/yesod-newsfeed.cabal @@ -1,5 +1,5 @@ name: yesod-newsfeed -version: 1.4.0 +version: 1.4.0.1 license: MIT license-file: LICENSE author: Michael Snoyman, Patrick Brisbin @@ -10,7 +10,8 @@ stability: Stable cabal-version: >= 1.6 build-type: Simple homepage: http://www.yesodweb.com/ -description: Helper functions and data types for producing News feeds. +description: API docs and the README are available at +extra-source-files: README.md ChangeLog.md library build-depends: base >= 4 && < 5 diff --git a/yesod-persistent/ChangeLog.md b/yesod-persistent/ChangeLog.md new file mode 100644 index 00000000..58406890 --- /dev/null +++ b/yesod-persistent/ChangeLog.md @@ -0,0 +1 @@ +No changes logged yet diff --git a/yesod-persistent/README b/yesod-persistent/README deleted file mode 100644 index e69de29b..00000000 diff --git a/yesod-persistent/README.md b/yesod-persistent/README.md new file mode 100644 index 00000000..1bb9191b --- /dev/null +++ b/yesod-persistent/README.md @@ -0,0 +1,3 @@ +## yesod-persistent + +Some helpers for using Persistent from Yesod. diff --git a/yesod-persistent/yesod-persistent.cabal b/yesod-persistent/yesod-persistent.cabal index 2e5735d7..c3bc1bff 100644 --- a/yesod-persistent/yesod-persistent.cabal +++ b/yesod-persistent/yesod-persistent.cabal @@ -1,5 +1,5 @@ name: yesod-persistent -version: 1.4.0.1 +version: 1.4.0.2 license: MIT license-file: LICENSE author: Michael Snoyman @@ -10,7 +10,8 @@ stability: Stable cabal-version: >= 1.8 build-type: Simple homepage: http://www.yesodweb.com/ -description: Some helpers for using Persistent from Yesod. +description: API docs and the README are available at +extra-source-files: README.md ChangeLog.md library build-depends: base >= 4 && < 5 diff --git a/yesod-newsfeed/README b/yesod-sitemap/ChangeLog.md similarity index 100% rename from yesod-newsfeed/README rename to yesod-sitemap/ChangeLog.md diff --git a/yesod-sitemap/README b/yesod-sitemap/README deleted file mode 100644 index e69de29b..00000000 diff --git a/yesod-sitemap/README.md b/yesod-sitemap/README.md new file mode 100644 index 00000000..087375a0 --- /dev/null +++ b/yesod-sitemap/README.md @@ -0,0 +1,3 @@ +## yesod-sitemap + +Generate XML sitemaps. diff --git a/yesod-sitemap/yesod-sitemap.cabal b/yesod-sitemap/yesod-sitemap.cabal index 6fea3ed6..511a21b7 100644 --- a/yesod-sitemap/yesod-sitemap.cabal +++ b/yesod-sitemap/yesod-sitemap.cabal @@ -1,5 +1,5 @@ name: yesod-sitemap -version: 1.4.0 +version: 1.4.0.1 license: MIT license-file: LICENSE author: Michael Snoyman @@ -10,7 +10,8 @@ stability: Stable cabal-version: >= 1.6 build-type: Simple homepage: http://www.yesodweb.com/ -description: Generate XML sitemaps. +description: API docs and the README are available at +extra-source-files: README.md ChangeLog.md library build-depends: base >= 4 && < 5 diff --git a/yesod-static/README b/yesod-static/README deleted file mode 100644 index e69de29b..00000000 diff --git a/yesod-static/README.md b/yesod-static/README.md new file mode 100644 index 00000000..30467439 --- /dev/null +++ b/yesod-static/README.md @@ -0,0 +1,3 @@ +## yesod-static + +Static file serving subsite for Yesod Web Framework. diff --git a/yesod-static/yesod-static.cabal b/yesod-static/yesod-static.cabal index 0396d637..4ccb0d7a 100644 --- a/yesod-static/yesod-static.cabal +++ b/yesod-static/yesod-static.cabal @@ -1,5 +1,5 @@ name: yesod-static -version: 1.4.0.3 +version: 1.4.0.4 license: MIT license-file: LICENSE author: Michael Snoyman @@ -10,7 +10,7 @@ stability: Stable cabal-version: >= 1.8 build-type: Simple homepage: http://www.yesodweb.com/ -description: Static file serving subsite for Yesod Web Framework. +description: API docs and the README are available at extra-source-files: sample.hs sample-embed.hs @@ -23,6 +23,7 @@ extra-source-files: test/embed-dir/lorem.txt test/embed-dir/abc/def.txt ChangeLog.md + README.md library build-depends: base >= 4 && < 5 diff --git a/yesod-test/yesod-test.cabal b/yesod-test/yesod-test.cabal index 72586eaa..65cda509 100644 --- a/yesod-test/yesod-test.cabal +++ b/yesod-test/yesod-test.cabal @@ -1,5 +1,5 @@ name: yesod-test -version: 1.4.2 +version: 1.4.2.1 license: MIT license-file: LICENSE author: Nubis @@ -10,7 +10,7 @@ stability: Experimental cabal-version: >= 1.8 build-type: Simple homepage: http://www.yesodweb.com -description: Behaviour Oriented integration Testing for Yesod Applications +description: API docs and the README are available at extra-source-files: README.md, LICENSE, test/main.hs, ChangeLog.md library diff --git a/yesod-websockets/ChangeLog.md b/yesod-websockets/ChangeLog.md new file mode 100644 index 00000000..58406890 --- /dev/null +++ b/yesod-websockets/ChangeLog.md @@ -0,0 +1 @@ +No changes logged yet diff --git a/yesod-websockets/yesod-websockets.cabal b/yesod-websockets/yesod-websockets.cabal index 434ea821..e4884bd9 100644 --- a/yesod-websockets/yesod-websockets.cabal +++ b/yesod-websockets/yesod-websockets.cabal @@ -1,5 +1,5 @@ name: yesod-websockets -version: 0.2.1 +version: 0.2.1.1 synopsis: WebSockets support for Yesod description: WebSockets support for Yesod homepage: https://github.com/yesodweb/yesod @@ -10,6 +10,8 @@ maintainer: michael@snoyman.com category: Web build-type: Simple cabal-version: >=1.8 +description: API docs and the README are available at +extra-source-files: README.md ChangeLog.md library exposed-modules: Yesod.WebSockets diff --git a/yesod/yesod.cabal b/yesod/yesod.cabal index 1de74693..c7603d7c 100644 --- a/yesod/yesod.cabal +++ b/yesod/yesod.cabal @@ -1,11 +1,11 @@ name: yesod -version: 1.4.1.2 +version: 1.4.1.3 license: MIT license-file: LICENSE author: Michael Snoyman maintainer: Michael Snoyman synopsis: Creation of type-safe, RESTful web applications. -description: Hackage documentation generation is not reliable. For up to date documentation, please see: . +description: API docs and the README are available at category: Web, Yesod stability: Stable cabal-version: >= 1.6