Merge pull request #123 from slamdata/update-readme

Update readme for current library, add compileable version to tests

Author: garyb

.gitignore

@@ -5,3 +5,4 @@
 /bower_components/
 /node_modules/
 /output/
+package-lock.json

README.md

@@ -27,37 +27,38 @@ You can construct requests with the `affjax` function:
 module Main where
 
 import Prelude
-import Control.Monad.Eff.Console (log)
-import Control.Monad.Eff.Class (liftEff)
-import Control.Monad.Aff (launchAff)
+
+import Data.Argonaut.Core as J
 import Data.Either (Either(..))
 import Data.HTTP.Method (Method(..))
-import Network.HTTP.Affjax (affjax, defaultRequest)
+import Effect.Aff (launchAff)
+import Effect.Class (liftEffect)
+import Effect.Console (log)
+import Network.HTTP.Affjax as AX
+import Network.HTTP.Affjax.Response as AXRes
 
 main = launchAff $ do
-  res <- affjax $ defaultRequest { url = "/api", method = Left GET }
-  liftEff $ log $ "GET /api response: " <> res.response
+  res <- AX.affjax AXRes.json (AX.defaultRequest { url = "/api", method = Left GET })
+  liftEffect $ log $ "GET /api response: " <> J.stringify res.response
 ```
 
 (`defaultRequest` is a record value that has all the required fields pre-set for convenient overriding when making a request.)
 
 Or use of a number of helpers for common cases:
 
 ```purescript
-import Network.HTTP.Affjax (get, post)
+import Network.HTTP.Affjax.Request as AXReq
 
 main = launchAff $ do
-  res1 <- get "/api"
-  liftEff $ log $ "GET /api response: " <> res1.response
+  res1 <- AX.get AXRes.json "/api"
+  liftEffect $ log $ "GET /api response: " <> J.stringify res1.response
 
-  res2 <- post "/api" someData
-  liftEff $ log $ "POST /api response: " <> res2.response
+  res2 <- AX.post AXRes.json "/api" (AXReq.json (J.fromString "test"))
+  liftEffect $ log $ "POST /api response: " <> J.stringify res2.response
 ```
 
 See the module documentation for a full list of these helpers.
 
-When sending data in a request the Requestable class enables automatic conversion into a format that is acceptable for an XHR request. Correspondingly there is a Respondable class for reading data that comes back from the server.
-
 ## Module documentation
 
 Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-affjax).

test/DocExamples.purs

@@ -0,0 +1,24 @@
+module Test.DocExamples where
+
+import Prelude
+
+import Data.Argonaut.Core as J
+import Data.Either (Either(..))
+import Data.HTTP.Method (Method(..))
+import Effect.Aff (launchAff)
+import Effect.Class (liftEffect)
+import Effect.Console (log)
+import Network.HTTP.Affjax as AX
+import Network.HTTP.Affjax.Request as AXReq
+import Network.HTTP.Affjax.Response as AXRes
+
+main = launchAff $ do
+  res <- AX.affjax AXRes.json (AX.defaultRequest { url = "/api", method = Left GET })
+  liftEffect $ log $ "GET /api response: " <> J.stringify res.response
+
+main' = launchAff $ do
+  res1 <- AX.get AXRes.json "/api"
+  liftEffect $ log $ "GET /api response: " <> J.stringify res1.response
+
+  res2 <- AX.post AXRes.json "/api" (AXReq.json (J.fromString "test"))
+  liftEffect $ log $ "POST /api response: " <> J.stringify res2.response