diff --git a/.github/settings.yml b/.github/settings.yml index f35e5d2..88b717f 100644 --- a/.github/settings.yml +++ b/.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" @@ -14,7 +13,5 @@ branches: contexts: - Codacy/PR Quality Review - Travis CI - Pull Request - - WIP - code-review/reviewable - coverage/coveralls - - license/cla diff --git a/.restyled.yaml b/.restyled.yaml new file mode 100644 index 0000000..450609f --- /dev/null +++ b/.restyled.yaml @@ -0,0 +1,5 @@ +--- +restylers: + - prettier-markdown: + enabled: false + - "*" diff --git a/README.md b/README.md index 1e0bdc3..12f343b 100644 --- a/README.md +++ b/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. -* -* +-