ethereumj-personal/README.md

40 lines
2.0 KiB
Markdown
Raw Normal View History

2014-11-21 15:22:36 +00:00
[![ScreenShot](http://i.imgur.com/lJw1Tui.jpg)]
2014-09-10 05:26:53 +00:00
2014-09-19 10:37:38 +00:00
# Welcome to ethereumj
2014-10-13 14:58:26 +00:00
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/ethereum/ethereumj?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/ethereum/ethereumj.svg?branch=master)](https://travis-ci.org/ethereum/ethereumj) [![Coverage Status](https://coveralls.io/repos/ethereum/ethereumj/badge.png?branch=master)](https://coveralls.io/r/ethereum/ethereumj?branch=master)
[![Stories in Progress](https://badge.waffle.io/ethereum/ethereumj.png?title=In%20Progress&label=in_progress)](https://waffle.io/ethereum/ethereumj)
2014-07-27 20:12:53 +00:00
2014-09-19 10:37:38 +00:00
# Goals
2014-07-27 20:12:53 +00:00
2014-09-19 10:37:38 +00:00
The ethereumj library is a Java implementation of the Ethereum protocol.
2014-06-21 15:21:44 +00:00
2014-09-19 10:37:38 +00:00
This repository currently contains:
* [core](ethereumj-core): the core library which can be included into your own Java project.
* [studio](ethereumj-studio): a simple graphic interface for Ethereum functionality and set of showcases for core usage.
2014-09-10 06:17:23 +00:00
2014-11-21 15:22:36 +00:00
For an early peek, have a looki at this [video](https://youtu.be/D5ok7jh7AOg)
2014-09-10 06:17:23 +00:00
2014-09-19 10:37:38 +00:00
# Todo
2014-09-10 06:15:40 +00:00
2014-09-19 10:37:38 +00:00
The Ethereum protocol is currenty heavily in development, thus so is this implementation.
2014-10-04 17:52:10 +00:00
You can find a todo-list right [here](TODO.md) and the [milestone schedule](https://github.com/ethereum/ethereumj/milestones).
For questions you can reach us in #ethereumj on Freenode.
2014-06-21 15:21:44 +00:00
2014-09-19 10:37:38 +00:00
# Documentation
2014-05-04 23:02:09 +00:00
2014-09-19 10:37:38 +00:00
To start you can visit [Ethereum.org](https://www.ethereum.org) and if you are looking for more information on the concept, the [ethereum white paper](https://github.com/ethereum/wiki/wiki/%5BEnglish%5D-White-Paper) is a good place to start as it outlines the vision. For the more technical minded, a protocol description can be found in the [yellow paper](http://gavwood.com/Paper.pdf) by Gavin Wood.
2014-06-21 15:21:44 +00:00
2014-09-19 10:37:38 +00:00
# Maven
2014-06-21 19:36:10 +00:00
2014-09-19 10:37:38 +00:00
The main ethereumj library can be found in the Maven repository
2014-06-21 19:36:10 +00:00
2014-09-19 10:37:38 +00:00
https://bintray.com/ethereum/maven/org.ethereum/view
2014-06-21 17:22:52 +00:00
2014-09-19 10:37:38 +00:00
For building ethereumj-core or ethereumj-studio look in their own individual README
2014-06-21 15:21:44 +00:00
2014-09-19 10:37:38 +00:00
# License
2014-06-21 15:21:44 +00:00
2014-09-19 10:37:38 +00:00
This software is released under the MIT license, read it [here](LICENSE)