Skip to content

Commit

Permalink
docs: update readme and add hint for 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
marc0olo committed Jan 4, 2022
1 parent f20e331 commit 70422d1
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,19 @@
## aepp-sdk-java
<a href='https://github.com/kryptokrauts/aepp-sdk-java/actions?query=workflow%3ASnapshot'><img src='https://github.com/kryptokrauts/aepp-sdk-java/workflows/Snapshot/badge.svg'></a>
[![codecov.io](http://codecov.io/github/kryptokrauts/aepp-sdk-java/coverage.svg?branch=3.x)](https://codecov.io/gh/kryptokrauts/aepp-sdk-java/branch/3.x)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkryptokrauts%2Faepp-sdk-java.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkryptokrauts%2Faepp-sdk-java?ref=badge_shield)

The **aepp-sdk-java** is a community developed Java SDK to interact with the æternity blockchain.

## Latest Release
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.kryptokrauts/aepp-sdk-java/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.kryptokrauts/aepp-sdk-java)
- [changelog](docs/changelog.md)

🚧 **Important** 🚧
- 3.0.0 is under development and close to be released
- The 3.0.0-RC1 was a test-release that doesn't reflect the current state of development
- The documentation reflects the latest state of development
- If you're new here we recommend to use [3.0.0-SNAPSHOT](https://kryptokrauts.github.io/aepp-sdk-java/index.html#snapshot) until 3.0.0 is released

## Documentation
The documentation placed in the `/docs` folder is generated via MkDocs and served via gh-pages:
- https://kryptokrauts.github.io/aepp-sdk-java
Expand All @@ -26,8 +31,6 @@ The documentation placed in the `/docs` folder is generated via MkDocs and serve

Licensed under the [ISC License](LICENSE)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkryptokrauts%2Faepp-sdk-java.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkryptokrauts%2Faepp-sdk-java?ref=badge_large)

## Support us

If you like this project we would appreciate your support. You can find multiple ways to support us here:
Expand Down

0 comments on commit 70422d1

Please sign in to comment.