PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-26 06:12:06 +01:00
Code Issues Releases Wiki Activity

Add inclusion section to readme

Browse source
This commit is contained in:
Paul Schaub 2018-07-19 19:01:16 +02:00
parent 408ddcaed1
commit a8255ec3f2
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -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 :)