Merge pull request #417 from cosmos/jack/README

Add content to the README

CONTRIBUTING.md

@@ -45,7 +45,7 @@ software.
 
 Since some dependencies are not under our control, a third party may break our
 build, in which case we can fall back on `dep ensure` (or `make
-get-vendor-deps`). Even for dependencies under our control, `dep` helps us to
+deps`). Even for dependencies under our control, `dep` helps us to
 keep multiple repos in sync as they evolve. Anything with an executable, such
 as apps, tools, and the core, should use `dep`.
 

Dockerfile

@@ -13,7 +13,7 @@ RUN apk add --update $PACKAGES
 COPY . .
 
 # Make the binary
-RUN make update-tools get-vendor-deps build
+RUN make update-tools deps build
 
 # Final image
 FROM alpine:edge

Makefile

@@ -24,9 +24,9 @@ ERRCHECK_CHECK := $(shell command -v errcheck 2> /dev/null)
 UNPARAM_CHECK := $(shell command -v unparam 2> /dev/null)
 GOCYCLO_CHECK := $(shell command -v gocyclo 2> /dev/null)
 
-all: get-tools get-vendor-deps install
+all: tools deps install
 
-ci: get-tools get-vendor-deps install
+ci: tools deps install
 
 build:
 ifeq ($(OS),Windows_NT)
@@ -45,7 +45,7 @@ update-tools:
 	@echo "Updating golang dependencies"
 	go get -u -v $(DEP) $(GOLINT) $(GOMETALINTER) $(UNCONVERT) $(INEFFASSIGN) $(MISSPELL) $(ERRCHECK) $(UNPARAM) $(GOCYCLO)
 
-get-tools:
+tools:
 	ifdef DEP_CHECK
 		@echo "Dep is already installed.  Run 'make update-tools' to update."
 	else
@@ -101,7 +101,7 @@ get-tools:
 		go get -v $(GOCYCLO)
 	endif
 
-get-vendor-deps:
+deps:
 	@rm -rf vendor/
 	@echo "--> Running dep ensure"
 	@dep ensure -v
@@ -115,4 +115,4 @@ docker:
 	docker tag ${DOCKER_IMAGE}:${DOCKER_TAG} ${DOCKER_IMAGE}:latest
 	docker tag ${DOCKER_IMAGE}:${DOCKER_TAG} ${DOCKER_IMAGE}:${COMMIT_HASH}
 
-.PHONY: build install update-tools get-tools get-vendor-deps godocs
+.PHONY: build install update-tools tools deps godocs

README.md

@@ -1,9 +1,39 @@
-# Ethermint Skeleton
+[![](https://godoc.org/github.com/cosmos/ethermint?status.svg)](http://godoc.org/github.com/cosmos/ethermint)  [![Go Report Card](https://goreportcard.com/badge/github.com/cosmos/ethermint)](https://goreportcard.com/report/github.com/cosmos/ethermint)
 
-To build, execute these two commands:
+# Ethermint
 
-dep ensure
+__**WARNING:**__ Ethermint is under VERY ACTIVE DEVELOPMENT and should be treated as pre-alpha software. This means it is not meant to be run in production, its APIs are subject to change without warning and should not be relied upon, and it should not be used to hold any value. We will remove this warning when we have a release that is stable, secure, and properly tested.
 
-go build main.go copied.go
+### What is it?
 
+`ethermint` will be an implementation of the EVM that runs on top of [`tendermint`](https://github.com/tendermint/tendermint) consensus, a Proof of Stake system. This project has as its primary goals:
 
+- [Hard Spoon](https://blog.cosmos.network/introducing-the-hard-spoon-4a9288d3f0df) enablement: This is the ability to take a token from the Ethereum mainnet and "spoon" (shift) the balances over to another network. This feature is intended to make it easy for applications that require more transactions than the Ethereum main chain can provide to move their code over to a compatible chain with much more capacity.
+-  Web3 Compatibility: In order enable applications to be moved over to an ethermint chain existing tooling (i.e. web3 compatable clients) need to be able to interact with `ethermint`.
+
+### Implementation Steps
+
+- [x] Have a working implementation that can parse and validate the existing ETH Chain and persist it in a Tendermint store
+- [ ] Benchmark this implementation to ensure performance
+- [ ] Allow the Ethermint EVM to interact with other [Cosmos SDK modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/core/app3.md)
+- [ ] Implement the Web3 APIs as a Cosmos Light Client for Ethermint
+- [ ] Ethermint is a full Cosmos SDK application and can be deployed as it's own zone
+
+### Building Ethermint
+
+To build, execute the following commands:
+
+```bash
+# To build the binary and put the results in ./build
+$ make tools deps build
+
+# To build the project and install it in $GOBIN
+$ make tools deps install
+```
+
+### Community
+
+The following chat channels and forums are a great spot to ask questions about Ethermint:
+
+- [Cosmos Riot Chat Channel](https://riot.im/app/#/group/+cosmos:matrix.org)
+- Cosmos Forum [![Discourse status](https://img.shields.io/discourse/https/forum.cosmos.network/status.svg)](https://forum.cosmos.network)