bsima/haskell-urbit-api
1
1
Fork 0
mirror of https://github.com/bsima/haskell-urbit-api.git synced 2024-09-11 18:27:08 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add hackage/license link/badge

Browse Source
This commit is contained in:
Ben Sima 2020-10-23 10:15:51 -04:00
parent 77868279ca
commit 81e78f1e0f
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,5 +1,9 @@
# Haskell Urbit API # Haskell Urbit API
[![License MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
[![Hackage](https://img.shields.io/hackage/v/req.svg?style=flat)](https://hackage.haskell.org/package/urbit-airlock)
This library helps you talk to your Urbit from Haskell, via HTTP. 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 The "Urbit Airlock" API is a command-query API that lets you hook into apps
@ -17,7 +21,9 @@ responses, we stream messages from a path associated with the app, such as
`/mailbox/~/~zod/mc`. Internally, I believe Urbit calls these `wire`s. `/mailbox/~/~zod/mc`. Internally, I believe Urbit calls these `wire`s.
`urbit-airlock` handles most of the path, session, and HTTP request stuff `urbit-airlock` handles most of the path, session, and HTTP request stuff
automatically. See the haddocks for more details. automatically. See the
[haddocks](https://hackage.haskell.org/package/urbit-airlock/docs/Urbit-Airlock.html)
for more details.
This library is built on req, conduit, and aeson, all of which are very stable This library is built on req, conduit, and aeson, all of which are very stable
and usable libraries for working with HTTP requests and web data. and usable libraries for working with HTTP requests and web data.