vhad/iota.lib.java
1
0
Fork 0
mirror of https://github.com/gosticks/iota.lib.java.git synced 2025-10-16 11:45:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #51 from jpkrohling/JPK-FixReadme

Browse Source 
Fixed README
This commit is contained in:
Oliver Nitzschke 2017-11-04 11:31:14 +01:00 committed by GitHub
commit a1f407eeff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
README.adoc
View File

@ -1,44 +1,49 @@
[![Build Status](https://travis-ci.org/iotaledger/iota.lib.java.svg?branch=master)](https://travis-ci.org/iotaledger/iota.lib.java)
image:https://travis-ci.org/iotaledger/iota.lib.java.svg?branch=master[link="https://travis-ci.org/iotaledger/iota.lib.java",title="Build Status"]
= Introduction
## Introduction
The JOTA library is a simple Java wrapper around link:http://www.iotatoken.com[IOTA] Node's JSON-REST HTTP interface.
The JOTA library is a simple Java wrapper around [[IOTA]](http://www.iotatoken.com/) Node's JSON-REST HTTP interface.
It allows to connect easily using Java directly to a local or a remote
link:https://iota.readme.io/docs/syncing-to-the-network[IOTA node].
It allows to connect easily using java directly to a local or a remote [[IOTA node]](https://iota.readme.io/docs/syncing-to-the-network).
- *Latest release:* 0.9.3
- *Compatibility:* fully compatible with IOTA IRI v1.4.0
- *API coverage:* 14 of 14 commands fully implemented
- *License:* Apache License 2.0
- *Readme updated:* 2017-09-23 21:05:02 (UTC)
* **Latest release:** 0.9.3
* **Compatibility:** fully compatible with IOTA IRI v1.4.0
* **API coverage:** 14 of 14 commands fully implemented
* **License:** Apache License 2.0
* **Readme updated:** 2017-09-23 21:05:02 (UTC)
A list of all *IOTA* JSON-REST API commands currently supported by JOTA wrapper can be found in the `Commands` enum
(see link:https://github.com/davassi/JOTA/blob/master/src/main/java/jota/IotaAPICommands.java[here] for more details).
A list of all *IOTA* JSON-REST API commands currently supported by jota wrapper can be found in the `Commands` enum (see [here](https://github.com/davassi/JOTA/blob/master/src/main/java/jota/IotaAPICommands.java) for more details).
JOTA java wrapper is being designed to be thread-safe and simplest as possible in order to be easily maintainable,
accordingly with the ongoing natural evolution of IOTA's API. All the boilerplate code for connecting to the node REST
interface has been eliminated using Retrofit.
JOTA java wrapper is being designed to be thread-safe and simplest as possible in order to be easily mantainable, accordingly with the ongoing natural evolution of IOTA'api.
All the boilerplate code for connecting to the node rest interface has been eliminated using Retrofit.
## Technologies & dependencies
== Technologies & dependencies
The JOTA library has been designed to be used with Java6+, in order to promote compatibility with Android.
Core dependencies:
* Retrofit Client 2.1.0 [[link]](https://square.github.io/retrofit/)
* Gson JSON Processor : [[link]](https://github.com/google/gson)
* Lombok 1.16.2 [[link]](https://github.com/rzwitserloot/lombok)
- link:https://square.github.io/retrofit/[Retrofit Client 2.1.0]
- link:https://github.com/google/gson[Gson JSON Processor]
- link:https://github.com/rzwitserloot/lombok[Lombok 1.16.2]
Other dependencies:
* Simple Logging Facade for Java 1.7.21 [[link]](http://www.slf4j.org/)
* Apache Commons Lang 3.3.2 [[link]](http://commons.apache.org/proper/commons-lang/)
## Getting started <a name="getting-started"></a>
- link:http://www.slf4j.org/[Simple Logging Facade for Java 1.7.21]
- link:http://commons.apache.org/proper/commons-lang/[Apache Commons Lang 3.3.2]
Connect to your local node with the default settings is quite straightforward: it requires only 2 lines of code. For example, in order to fetch the Node Info:
== Getting started [[getting-started]]
Connecting to your local node with the default settings is quite straightforward: it requires only 2 lines of code.
For example, in order to fetch the Node Info:
IotaAPI api = new IotaAPI.Builder().build();
GetNodeInfoResponse response = api.getNodeInfo();
of if you need to connect to a remote node:
or if you need to connect to a remote node:
IotaAPI api = new IotaAPI.Builder()
.protocol("http")
@ -48,31 +53,29 @@ of if you need to connect to a remote node:
GetNodeInfoResponse response = api.getNodeInfo();
In order to communicate with *IOTA node*, JOTA needs to be aware of your node's exact configuration. If you dont want to use the builder the easiest way of providing this information is via a `node_config.properties` file, for example:
In order to communicate with *IOTA node*, JOTA needs to be aware of your node's exact configuration. If you don't want
to use the builder, the easiest way of providing this information is via a `node_config.properties` file, for example:
iota.node.protocol=http``****************``
iota.node.host=127.0.0.1
iota.node.port=14265
Jota is still *not* in the central maven repository.
## Warning
== Warning
- This is pre-release software!
- There may be performance and stability issues.
- You may loose all your money :)
- Please report any issues using the <a href="https://github.com/iotaledger/iota.lib.java/issues">Issue Tracker</a>
## Examples
== Examples
There's an extensive list of test coverages on the src/test/java package of the project that can be used as reference.
There's an extensive list of test coverages on the `src/test/java` directory that can be used as reference.
## Documentation
== Documentation
A hosted version of the javadoc for the latest release can be found [here](https://iotaledger.github.io/iota.lib.java/javadoc/)
## Supporting the project
== Supporting the project
If JOTA has been useful to you and you feel like contributing, consider posting a bug report or a pull request.