Skip to content

Commit

Permalink
doc update for 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
gnahraf committed Sep 8, 2022
1 parent 76ef53b commit 8e2cf84
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

A Merkle tree library written in Java.

## Maven

To use this module add this dependency in your POM file:

```
<dependency>
<groupId>io.crums</groupId>
<artifactId>merkle-tree</artifactId>
<version>1.0.0</version>
</dependency>
```

## Design Goals

An easy-to-understand, fast, tamper-proof API for building, navigating Merkle tree structures. Support for Merkle tree proofs (of existence).
Expand Down Expand Up @@ -60,7 +72,7 @@ There's a good amount javadoc comment in the source. (Useful in IDEs like Eclips

### Project Doc Site

Project documentation (a version of this page plus javadoc API) is availabe [here](https://crums-io.github.io/merkle-tree/).
The project doc site is [here](https://crums-io.github.io/merkle-tree/).


## Notes
Expand Down Expand Up @@ -88,6 +100,10 @@ The current design exposes data as byte arrays. This necessitates copying the da

## Status

Sept 8 2022

> 1.0.0 Released. Available on Maven Central.
Feb 11 2021

> 0.0.2 Released under LGPL.
Expand Down

0 comments on commit 8e2cf84

Please sign in to comment.