fix versions and update readme (#123)

* fix versions

* update readme

* semver link

Author: ebuchman

README.md

@@ -1,28 +1,43 @@
 # ibc-rs
 
-Rust implementation of IBC modules and relayer.
+Rust implementation of Interblockchain Communication (IBC) 
+[modules](/modules) and 
+[relayer](/relayer).
+
+Includes [TLA+ specifications](/docs/spec).
 
 ## Disclaimer
 
 THIS PROJECT IS UNDER HEAVY DEVELOPMENT AND IS NOT IN A WORKING STAGE NOW, USE AT YOUR OWN RISK.
 
-## Requirements
-
-- Rust 1.42+ (might work on earlier versions but this has not been tested yet)
+## Releases
 
+This project is still a pre v0.1.0 prototype. Releases can be found
+[here](https://github.com/informalsystems/ibc-rs/releases)
 
-## Relayer usage
+## Installation 
 
+Requires Rust 1.42+ (might work on earlier versions but this has not been tested yet)
 
-### Requirements
+These are instructions for setting up a local development environment with two
+IBC-enabled local blockchains that the relayer can run against.
 
-Prerequisites to run the instructions below:
+Dependencies:
 
 - `jq`, a command-line JSON processor
-- To use and test the present relayer implementation, we first need a Tendermint instance that supports IBC; see more details on setting up a basic instance in the [development environment](#development-environment) part below.
+- [`gaia`](https://github.com/cosmos/gaia), a blockchain supporting IBC 
 
+Clone the relayer implementation from [iqlusioninc/relayer](https://github.com/iqlusioninc/relayer/).
+We are interested in two commands we can run from this repo:
 
-### Instructions
+- `bash scripts/two-chainz "local" "skip"`. Running this script will instantiate two chains, listening on ports `26557` and `26657`, respectively.
+
+
+- `bash dev-env`. Running this script from your local source instantiates two chains, on ports `26557` and `26657`, and starts a relayer that sets up one connection, one channel and sends a few packets over the channel.
+
+Note that these script rely on the [cosmos/gaia](https://github.com/cosmos/gaia) implementation, which is a Cosmos-SDK application for the cosmos hub. 
+
+## Running the Relayer
 
 Assuming two Tendermint nodes running on local ports `26557` and `26657`.
 Suppose we use the name `chain_A` to refer to the node running on port `26657`, and the name `chain_B` for the node running on port `26557`.
@@ -73,23 +88,30 @@ The `relayer/cli/src/commands.rs` file contains further description of the CLI s
 
 **Note:** Add a `-v` flag to the commands above to see detailed log output, eg. `cargo run --bin relayer -- -v -c ./relayer/relay/tests/config/fixtures/relayer_conf_example.toml run`
 
+## Contributing
 
-### Development environment
-
-To set up a local development environment, clone the relayer implementation from [iqlusioninc/relayer](https://github.com/iqlusioninc/relayer/).
-We are interested in two commands we can run from this repo:
+IBC is specified in English in the [cosmos/ics repo](https://github.com/cosmos/ics). Any
+protocol changes or clarifications should be contributed there.
 
-- `bash scripts/two-chainz "local" "skip"`. Running this script will instantiate two chains, listening on ports `26557` and `26657`, respectively.
+This repo contains the TLA+ specification and Rust implementation for the IBC
+modules and relayer. If you're interested in contributing, please comment on an issue or open a new
+one!
 
+## Versioning
 
-- `bash dev-env`. Running this script script from your local source instantiates two chains, on ports `26557` and `26657`, and starts a relayer that sets up one connection, one channel and sends a few packets over the channel.
+We follow [Semantic Versioning](https://semver.org/), but none of the APIs are stable yet. Expect
+anything to break with each release until `v0.1.0`.
 
-Note that these script rely on the [cosmos/gaia](https://github.com/cosmos/gaia) implementation, which is a Cosmos-SDK application for the cosmos hub. 
+## Resources
 
+- [IBC Website](https://cosmos.network/ibc)
+- [IBC Specification](https://github.com/cosmos/ics)
+- [IBC Modules in Go](https://github.com/cosmos/cosmos-sdk/tree/master/x/ibc)
+- [IBC Relayer in Go](https://github.com/iqlusioninc/relayer)
 
 ## License
 
-Copyright © 2020 Informal Systems
+Copyright © 2020 Informal Systems Inc. and ibc-rs authors.
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 

modules/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "relayer-modules"
-version = "0.1.0"
+version = "0.0.1"
 edition = "2018"
 authors = [
   "Anca Zamfir <[email protected]>",

relayer/cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "relayer-cli"
-version = "0.1.0"
+version = "0.0.1"
 edition = "2018"
 authors = [
   "Anca Zamfir <[email protected]>",
@@ -30,4 +30,4 @@ version = "0.5.2"
 
 [dev-dependencies]
 abscissa_core = { version = "0.5.2", features = ["testing"] }
-once_cell = "1.2"
+once_cell = "1.2"

relayer/relay/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "relayer"
-version = "0.1.0"
+version = "0.0.1"
 edition = "2018"
 authors = [
   "Anca Zamfir <[email protected]>",