summaryrefslogtreecommitdiff
path: root/Network/HTTP/Simple.hs
diff options
context:
space:
mode:
Diffstat (limited to 'Network/HTTP/Simple.hs')
-rw-r--r--Network/HTTP/Simple.hs20
1 files changed, 9 insertions, 11 deletions
diff --git a/Network/HTTP/Simple.hs b/Network/HTTP/Simple.hs
index 95c723d..eb55e52 100644
--- a/Network/HTTP/Simple.hs
+++ b/Network/HTTP/Simple.hs
@@ -6,17 +6,15 @@
-- available at
-- <https://github.com/commercialhaskell/jump/blob/master/doc/http-client.md>.
--
--- Important note: 'Request' is an instance of 'IsString', and therefore
--- recommended usage is to turn on @OverloadedStrings@, e.g.
---
--- @@@
--- {-# LANGUAGE OverloadedStrings #-}
--- import Network.HTTP.Simple
--- import qualified Data.ByteString.Lazy.Char8 as L8
---
--- main :: IO ()
--- main = httpLBS "http://example.com" >>= L8.putStrLn
--- @@@
+-- Important note: 'H.Request' is an instance of 'Data.String.IsString', and
+-- therefore recommended usage is to turn on @OverloadedStrings@, e.g.
+--
+-- > {-# LANGUAGE OverloadedStrings #-}
+-- > import Network.HTTP.Simple
+-- > import qualified Data.ByteString.Lazy.Char8 as L8
+-- >
+-- > main :: IO ()
+-- > main = httpLBS "http://example.com" >>= L8.putStrLn
module Network.HTTP.Simple
( -- * Perform requests
httpLBS