<p align="center">
<i>Krypton client for Android and the JVM.</i>
<br/><br/>
<a href="https://github.com/krypton-org/krypton-android/actions?query=workflow%3A%22Java+CI+with+Gradle%22">
  <img src="https://github.com/krypton-org/krypton-android/workflows/Java%20CI%20with%20Gradle/badge.svg">
</a>

Krypton Android is the core client library used to connect to Krypton Authentification server. It is based on the Krypton client specification.

Getting started

Installation

TODO: This library requires Java 11 and higher?

Maven

TODO: add maven dependency commands

Gradle

TODO: add gradle dependency commands

Usage

Basic example

Considering you have an instance of Krypton Auth server running on "http://localhost:5000/auth":

import com.krypton.core.KryptonClient;

KryptonClient client = new KryptonClient("http://localhost:5000/auth");
client.register("toto@toto.com", "totototo");

//TODO: continue and comment this example

Advanced example

TODO

API

List of available methods and classes. Probably generate JavaDoc and host it somewhere. Write the link here.

Contributing

Contributing policy

TODO

Development setup

Clone the repository and cd to the directory. To build the project, run:

./gradlew build

The first time you do so, Gradle should download all the dependencies on your computer. It will compile the project and run the unit tests.

The project skeleton has been built following the official Gradle documentation to build librairies.

Later, we need to follow this guide to generate the right packages for Gradle and Maven.

Need to add a new dependency? Add it in build.gradle.

License and copyright

This project is licensed under the MIT License. No copyright assignment is necessary to contribute, so copyrights are shared among contributors.