Merge pull request #99 from input-output-hk/rvl/94/readme

Add more information to README.md

.travis.yml

@@ -98,8 +98,9 @@ jobs:
     name: "Haddock"
     script:
     - tar xzf $STACK_WORK_CACHE
+    - cp -Rv specifications/api api
     - mkdir -p haddock && mv $(stack path --local-doc-root)/* haddock
-    - git add haddock && git commit -m $TRAVIS_COMMIT
+    - git add api haddock && git commit -m $TRAVIS_COMMIT
     - git checkout gh-pages && git cherry-pick -X theirs -n - && git commit --allow-empty --no-edit
     - git push -f -q https://WilliamKingNoel-Bot:$GITHUB_ACCESS_TOKEN@github.com/input-output-hk/cardano-wallet gh-pages &>/dev/null
 

README.md

@@ -1,17 +1,54 @@
 <p align="center">
-  <big><strong>Cardano-Wallet</strong></big>
+  <big><strong>Cardano Wallet</strong></big>
 </p>
 
 <p align="center">
   <img width="200" src=".github/images/cardano-logo.png"/>
 </p>
 
 <p align="center">
-  <!-- We will need to decide on that soon enough <img src="https://img.shields.io/badge/version-x.x.x-ff69b4.svg?style=for-the-badge" /> -->
+  <a href="https://github.com/input-output-hk/cardano-wallet/releases"><img src="https://img.shields.io/github/release/input-output-hk/cardano-wallet.svg?style=for-the-badge" /></a>
   <a href="https://travis-ci.org/input-output-hk/cardano-wallet"><img src="https://img.shields.io/travis/input-output-hk/cardano-wallet.svg?style=for-the-badge" /></a>
   <a href="https://coveralls.io/github/input-output-hk/cardano-wallet"><img src="https://img.shields.io/coveralls/github/input-output-hk/cardano-wallet.svg?style=for-the-badge" /></a>
 </p>
 
+<hr/>
+
+Cardano Wallet helps you manage your Ada. You can use it to send and
+receive payments on the [Cardano](https://www.cardano.org) blockchain.
+
+This project provides an HTTP Application Programming Interface (API)
+and command-line interface (CLI) for working with your wallet.
+
+It can be used as a component of a frontend such as
+[Daedalus](https://daedaluswallet.io), which provides a friendly user
+interface for wallets. Most users who would like to use Cardano should
+start with Daedalus.
+
+## Development
+
+This source code repository contains the next major version of Cardano
+Wallet, which has been completely rewritten for the
+[Shelley](https://cardanoroadmap.com/) phase.
+
+The Byron version of Cardano Wallet is in the
+[cardano-sl](https://github.com/input-output-hk/cardano-sl)
+repository.
+
+## How to build
+
+Use [Haskell Stack](https://haskellstack.org/) to build this project:
+
+    stack build --test
+
+
+## Documentation
+
+ * Users of the Cardano Wallet API can refer to the [API Documentation](https://input-output-hk.github.io/cardano-wallet/api/).
+ * Development-related information can be found in the [Wiki](https://github.com/input-output-hk/cardano-wallet/wiki).
+ * To help understand the source code, refer to the [Haddock Documentation](https://input-output-hk.github.io/cardano-wallet/haddock/).
+
+
 <hr/>
 
 <p align="center">

src/Cardano/Wallet/Binary/Packfile.hs

@@ -45,8 +45,7 @@ decodePackfile pf = case runGetOrFail getHeader pf of
         Left e -> Left e
         Right () -> case runGetOrFail getBlobs rest of
             Left (_, _, msg) -> Left (BlobDecodeError msg)
-            Right ("", _, res) -> Right res
-            Right (_, _, _) -> Left (BlobDecodeError "Unconsumed data")
+            Right (_, _, res) -> Right res
 
 data Header = Header !BS.ByteString !Int
 

test/unit/Cardano/Wallet/Binary/PackfileSpec.hs

@@ -47,10 +47,14 @@ spec = do
             let decoded = decodePackfile "\254CARDANOYOLO\NUL\NUL\NUL\SOH"
             decoded `shouldBe` Left WrongFileTypeError
 
-        it "should ensure pack file version" $ do
+        it "should ensure pack file version is lesser" $ do
             let decoded = decodePackfile "\254CARDANOPACK\NUL\NUL\NUL\2"
             decoded `shouldBe` Left VersionTooNewError
 
+        it "should ensure pack file version is greater" $ do
+            let decoded = decodePackfile "\254CARDANOPACK\NUL\NUL\NUL\0"
+            decoded `shouldBe` Left VersionTooOldError
+
         it "should decode an empty pack file" $ do
             decodePackfile packFileHeader `shouldBe` Right []