From a8255ec3f2ca4954785908ab4754cf85f5454c50 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Thu, 19 Jul 2018 19:01:16 +0200 Subject: [PATCH] Add inclusion section to readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 7627ebdc..3eeac01d 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,21 @@ PGPainless is based around the Bouncycastle java library and can be used on Andr ### NOTE: PGPainless is in a *very* early state of development and should under no circumstances be used for serious production usage yet. +## Include PGPainless in your Project + +PGPainless is available on maven central. In order to include it in your project, just add the +maven central repository and add PGPainless as a dependency. + +``` +repositories { + mavenCentral() +} + +dependencies { + compile 'org.pgpainless:pgpainless-core:0.0.1-alpha1' +} +``` + ## How to use PGPainless The entry point to the API is the `PGPainless` class. Here you can find methods for a quick start :)