Skip to content

Commit

Permalink
docs: Update readme to better reflect the repo split.
Browse files Browse the repository at this point in the history
  • Loading branch information
iphydf committed May 17, 2020
1 parent 3fd166a commit 7ac25a5
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 25 deletions.
5 changes: 1 addition & 4 deletions .github/settings.yml
@@ -1,11 +1,10 @@
---
_extends: template
_extends: .github

repository:
name: hs-msgpack-rpc-conduit
description: A MessagePack RPC implementation in Haskell
topics: msgpack, rpc, protocol, network
has_issues: true

branches:
- name: "master"
Expand All @@ -14,7 +13,5 @@ branches:
contexts:
- Codacy/PR Quality Review
- Travis CI - Pull Request
- WIP
- code-review/reviewable
- coverage/coveralls
- license/cla
5 changes: 5 additions & 0 deletions .restyled.yaml
@@ -0,0 +1,5 @@
---
restylers:
- prettier-markdown:
enabled: false
- "*"
27 changes: 6 additions & 21 deletions README.md
@@ -1,26 +1,11 @@
MessagePack for Haskell
=======================
# MessagePack for Haskell

This is an implementation of msgpack for Haskell.

It containes:

* Serializer/Deserializer
* RPC

# Install

Execute following instructions:

~~~ {.bash}
$ cabal update
$ cabal install data-msgpack
$ cabal install network-msgpack-rpc
~~~
This is an implementation of a msgpack RPC protocol for Haskell. It uses conduit
to establish TCP connections and send messages over this connection. Both client
and server are provided.

# Document

There are Haddoc documents on Hackage Database.
There are Haddock documents on Hackage Database.

* <http://hackage.haskell.org/package/data-msgpack>
* <http://hackage.haskell.org/package/network-msgpack-rpc>
- <http://hackage.haskell.org/package/msgpack-rpc-conduit>

0 comments on commit 7ac25a5

Please sign in to comment.