Corrections to README
- prefer 'the' to 'our'
- it's called the "spec"
@@ -11,13 +11,13 @@ sidechains like [Liquid](https://blockstream.com/liquid/), expanding use cases
possible via today's Bitcoin network, while bringing superior money to other
chains.
-This repo contains the Solidity [smart contracts](implementation/) and [whitepaper](documentation/).
+This repo contains the Solidity [smart contracts](implementation/) and [specification](documentation/).
## Getting started
- * Read the [Whitepaper](http://docs.keep.network/tbtc/)
+ * Read the [specification](http://docs.keep.network/tbtc/)
* Consult [Solidity API documentation](http://docs.keep.network/tbtc/solidity/)
- * For questions and support, join us on [Discord](https://discord.gg/4R6RGFf).
+ * For questions and support, join the #tbtc channel on [Discord](https://discord.gg/4R6RGFf).
## Installation
@@ -43,15 +43,15 @@ contract MySystem {
## Contributing
-We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
+All contributions are welcome. To report bugs, please create an issue on this repository. To start a discussion, prefer Discord over GitHub issues.
-**Read our [Contributing guidelines](https://github.com/keep-network/tbtc/blob/master/CONTRIBUTING.md).**
+**Read the [Contributing guidelines](https://github.com/keep-network/tbtc/blob/master/CONTRIBUTING.md).**
### Prerequisites
* Node.js, [npm](https://docs.npmjs.com/cli/install)
* A local Ethereum blockchain. We recommend [Ganache](https://www.trufflesuite.com/ganache).
- * Truffle framework.
+ * [Truffle framework](https://www.trufflesuite.com/docs/truffle/overview).
### Build
@@ -83,7 +83,7 @@ contract.only('TBTCToken', function(accounts) {
### Lint
-We use ESLint and Solium for linting code. To run:
+We use [ESLint](https://eslint.org/) and [Ethlint](https://github.com/duaraghav8/Ethlint) for linting code. To run:
```sh
npm run sol:lint:fix
