Merge pull request #37 from purescript/comonads

Comonad transformer docs
purescript · Mar 24, 2015 · b64544b · b64544b
2 parents 728e25f + 0e919af
commit b64544b
Show file tree

Hide file tree

Showing 26 changed files with 713 additions and 418 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -16,40 +16,52 @@ module.exports = function(grunt) {
     pscDocs: {
         trans: {
             src: "src/Control/Monad/Trans.purs",
-            dest: "docs/Trans.md"
+            dest: "docs/Monad/Trans.md"
         },
         cont: {       
             src: "src/Control/Monad/Cont/*.purs",
-            dest: "docs/Cont.md"
+            dest: "docs/Monad/Cont.md"
         },
         error: {
             src: ["src/Control/Monad/Error/*.purs", "src/Control/Monad/Error.purs"],
-            dest: "docs/Error.md"
+            dest: "docs/Monad/Error.md"
         },
         maybe: {
             src: "src/Control/Monad/Maybe/*.purs",
-            dest: "docs/Maybe.md"
+            dest: "docs/Monad/Maybe.md"
         },
         reader: {
             src: ["src/Control/Monad/Reader/*.purs", "src/Control/Monad/Reader.purs"],
-            dest: "docs/Reader.md"
+            dest: "docs/Monad/Reader.md"
         },
         rws: {
             src: ["src/Control/Monad/RWS/*.purs", "src/Control/Monad/RWS.purs"],
-            dest: "docs/RWS.md"
+            dest: "docs/Monad/RWS.md"
         },
         state: {
             src: ["src/Control/Monad/State/*.purs", "src/Control/Monad/State.purs"],
-            dest: "docs/State.md"
+            dest: "docs/Monad/State.md"
         },
         writer: {
             src: ["src/Control/Monad/Writer/*.purs", "src/Control/Writer/Reader.purs"],
-            dest: "docs/Writer.md"
+            dest: "docs/Monad/Writer.md"
+        },
+        cotrans: {
+            src: "src/Control/Comonad/Trans.purs",
+            dest: "docs/Comonad/Trans.md"
+        },
+        env: {       
+            src: ["src/Control/Comonad/Env/*.purs", "src/Control/Comonad/Env.purs"],
+            dest: "docs/Comonad/Env.md"
+        },
+        store: {
+            src: ["src/Control/Comonad/Store/*.purs", "src/Control/Comonad/Store.purs"],
+            dest: "docs/Comonad/Store.md"
+        },
+        traced: {
+            src: ["src/Control/Comonad/Traced/*.purs", "src/Control/Comonad/Traced.purs"],
+            dest: "docs/Comonad/Traced.md"
         },
-        comonads: {
-            src: "src/Control/Comonad/**/*.purs",
-            dest: "docs/Comonad.md"
-        }
     },
 
     psc: {

diff --git a/README.md b/README.md
@@ -3,7 +3,26 @@ purescript-transformers
 
 [![Build Status](https://travis-ci.org/purescript/purescript-transformers.svg?branch=master)](https://travis-ci.org/purescript/purescript-transformers)
 
-Monad transformers based on [mtl](http://hackage.haskell.org/package/mtl).
+Monad and comonad transformers based on [mtl](http://hackage.haskell.org/package/mtl).
 
-- [Module documentation](docs/)
 - [Examples](examples/)
+
+## Documentation
+
+### Monad Transformers
+
+- [MonadTrans](docs/Monad/Trans.md)
+- [Errors](docs/Monad/Error.md)
+- [Maybe](docs/Monad/Maybe.md)
+- [State](docs/Monad/State.md)
+- [Writer](docs/Monad/Writer.md)
+- [Reader](docs/Monad/Reader.md)
+- [Reader/Writer/State](docs/Monad/RWS.md)
+- [CPS](docs/Monad/Cont.md)
+
+### Comonad Transformers
+
+- [ComonadTrans](docs/Comonad/Trans.md)
+- [Environment](docs/Comonad/Env.md)
+- [Store](docs/Comonad/Store.md)
+- [Cowriter](docs/Comonad/Traced.md)