Merge branch 'dev' into 'master'

Proof of concept release

See merge request interlay/btc-parachain!41

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2020 Interlay Ltd
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -8,7 +8,7 @@ This is a proof of concept implementation of a BTC Parachain to bring Bitcoin in
 It allows the creation of **PolkaBTC**, a fungible token that represents Bitcoin in the Polkadot ecosystem.
 PolkaBTC is backed by Bitcoin 1:1 and allows redeeming of the equivalent amount of Bitcoins by relying on a collateralized third-party.
 
-![overview](https://gitlab.com/interlay/polkabtc-spec/-/blob/dev/polkabtc-spec/docs/source/figures/overview.png "BTC Parachain Overview")
+![overview](https://interlay.gitlab.io/polkabtc-spec/_images/overview.png "BTC Parachain Overview")
 
 The project uses the concept of [Cryptocurrency-backed Assets](https://xclaim.io) to lock Bitcoin on the Bitcoin blockchain and issue BTC-backed tokens on the BTC Parachain.
 The implementation is based on the [BTC Parachain specification](https://interlay.gitlab.io/polkabtc-spec/).
@@ -29,3 +29,9 @@ If you would like to contribute, please file an issue on GitLab or reach out to
 - [Riot](https://matrix.to/#/!nZablWWaicZyVTWyZk:matrix.org?via=matrix.org)
 
 We are [hiring](https://www.interlay.io/careers/)!
+
+## Copyright and License
+
+(C) Copyright 2020 [Interlay](https://www.interlay.io) Ltd
+
+BTC-Parachain is currently licensed under the terms of the Apache License (Version 2.0). See LICENSE

crates/bitcoin/src/README.md

@@ -0,0 +1,47 @@
+# Bitcoin library
+
+Library handling BTC-Relay and Bitcoin specific data types and provides parsing and verficaition functionality.
+
+* types.rs: BTC-Relay / Bitcoin data model
+* parser.rs: Parsing Bitcoin block headers and transactions
+* merkle.rs: Verification of Merkle Proofs
+* utils.rs: Bitcoin-specific util functions
+
+## Installation
+
+Run `cargo build` from the root folder of this directory.
+
+## Testing
+
+Run `cargo test` from the root folder of this directory.
+
+
+## Integration into Runtimes 
+
+### Runtime `Cargo.toml`
+
+To add this pallet to your runtime, simply include the following to your runtime's `Cargo.toml` file:
+
+```TOML
+[dependencies.bitcoin]
+default_features = false
+git = '../creates/bitcoin'
+```
+
+and update your runtime's `std` feature to include this pallet:
+
+```TOML
+std = [
+    # --snip--
+    'bitcoin/std',
+]
+```
+
+## Reference Docs
+
+You can view the reference docs for this pallet by running:
+
+```
+cargo doc --open
+```
+

crates/btc-core/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "btc-core"
 version = "0.1.0"
-authors = ["Daniel Perez <[email protected]>"]
+authors = ["Interlay Ltd"]
 edition = "2018"
 
 [features]