From 5f32ce5dd640b8edef64d361f362c34847816512 Mon Sep 17 00:00:00 2001 From: anthdm Date: Sun, 28 Jan 2018 19:37:03 +0100 Subject: [PATCH] added more details to the readme. --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2be7e4a54..114df5fb7 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,23 @@ # Overview ### Long term project goals -Full port of the original C# NEO project. A complete toolkit for the NEO blockchain. +Full port of the original C# [NEO project](https://github.com/neo-project). A complete toolkit for the NEO blockchain. -- Full server (consensus, RPC bookkeeping) nodes. +- Full server (consensus, RPC and bookkeeping) nodes. - RPC client - build, compile and deploy smart contracts with the Go vm # Current state -This project is still under heavy development. Still working on internal API's and project layout. \ No newline at end of file +This project is still under heavy development. Still working on internal API's and project layout. This should not take longer than 2 weeks. + +# Getting started +If you can't wait to experiment with the current state of the project. clone the project, cd into it and run: + +`go install ./cmd/neoserver` + +Make sure you have a private net running. If you dont, take a look at [docker-privnet-with-gas](https://hub.docker.com/r/metachris/neo-privnet-with-gas/). + +`neoserver -seed 127.0.0.1:20333` + +The only thing the server currently will do is asking for peers and connect to the responded peers. All other messages are in development. +