From 61a25bfe6d1e939148e5f65edcc119b247778ab5 Mon Sep 17 00:00:00 2001 From: Luke Schoen Date: Sat, 27 Jan 2018 08:10:15 +1100 Subject: [PATCH] docs: Add Mix Installation and Documentation generation guide --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 78ccebd..014b834 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,34 @@ An Erlang application that allows writing [Application Blockchain Interface](https://github.com/tendermint/abci) servers. +ABCI Server with Erlang bindings is used by the [Tendermint Ecosystem](http://tendermint.readthedocs.io/projects/tools/en/master/ecosystem.html#abci-servers) + This application uses [semantic versioning 2.0](http://semver.org/). [erlang.mk](https://erlang.mk/) is used as a build tool. +## Installation with Mix + +* Add ABCI Server (Erlang) to mix.exs. [Choose a Release Tag](https://github.com/KrzysiekJ/abci_server/tags) + ```elixir + defp deps do + [ + # ABCI Server (Erlang) - https://github.com/KrzysiekJ/abci_server + {:abci_server, git: "https://github.com/KrzysiekJ/abci_server.git", tag: "v0.4.0"} + ] + end + ``` + +* Install Mix Dependencies + ```bash + mix deps.get + ``` + +* Documentation Generation. Open Documentation in Web Browser + ```bash + cd deps/abci_server/ && make docs && open doc/index.html && cd ../../ + ``` + ## Documentation Run `make docs` and open `doc/index.html`.