From 22108527f3083696328ec7c00355d078470ca104 Mon Sep 17 00:00:00 2001 From: Christian Basler Date: Tue, 24 May 2016 19:35:41 +0200 Subject: [PATCH] Minor update to the README file --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fd9d955..16a2528 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,12 @@ Jabit [![Apache 2](https://img.shields.io/badge/license-Apache_2.0-blue.svg)](https://raw.githubusercontent.com/Dissem/Jabit/master/LICENSE) [![Visit our IRC channel](https://img.shields.io/badge/irc-%23jabit-blue.svg)](https://kiwiirc.com/client/irc.freenode.net/#jabit) -A Java implementation for the Bitmessage protocol. To build, use command -`gradle build` or `./gradlew build`. +A Java implementation for the Bitmessage protocol. To build, use command `./gradlew build`. Please note that it still has its limitations, but the API should now be stable. Jabit uses Semantic Versioning, meaning as long as the major version doesn't change, nothing should break if you update. +Be aware though that this doesn't necessarily applies for SNAPSHOT builds and the development branch, notably when it comes to database updates. _In other words, they may break your installation!_ + #### Master [![Build Status](https://travis-ci.org/Dissem/Jabit.svg?branch=master)](https://travis-ci.org/Dissem/Jabit) [![Code Quality](https://img.shields.io/codacy/e9938d2adbb74a0db553115bef692ff3/master.svg)](https://www.codacy.com/app/chrigu-meyer/Jabit/dashboard?bid=3144281)