add simple readme and doc edit

This commit is contained in:
Ben Sima 2020-10-22 18:27:13 -04:00
parent 0fa5ac2461
commit 23e45e0e14
2 changed files with 10 additions and 1 deletions

9
README.md Normal file
View File

@ -0,0 +1,9 @@
# Haskell Urbit API
This library helps you talk to your Urbit from Haskell, via HTTP.
The "Urbit Airlock" API is a command-query API that lets you hook into apps
running on your Urbit. You can submit commands (called "pokes") and subscribe to
responses.
See the `test.hs` file for some example usages.

View File

@ -31,6 +31,7 @@ import qualified Network.HTTP.Req as Req
import qualified Network.HTTP.Req.Conduit as Req
import qualified Text.URI as URI
-- | Some information about your ship needed to establish connection.
data Ship = Ship
{ -- | A random string for your channel.
uid :: Text,
@ -58,7 +59,6 @@ type Mark = Text
-- | The `@p` for the ship (no leading ~).
type ShipName = Text
-- |
nextEventId :: Ship -> Int
nextEventId Ship {lastEventId} = lastEventId + 1