Update POM file and README.
Do not depend on incenp-base anymore.
This commit is contained in:
parent
465a9727fd
commit
4948a24435
27
README.md
27
README.md
|
@ -6,18 +6,25 @@ Incenp-SJCL aims to provide a
|
|||
library.
|
||||
|
||||
|
||||
Contents
|
||||
--------
|
||||
The aim of the library is to give Java code the ability to decrypt data
|
||||
that has been encrypted with SJCL’s `encrypt()` convenience function and
|
||||
to encrypt data that can later be decrypted with SJCL’s `decrypt()`
|
||||
function.
|
||||
|
||||
To that end, currently the library provides a `org.incenp.sjcl.SJCL`
|
||||
static class with the static methods `encrypt()` and `decrypt()`.
|
||||
|
||||
All cryptographic operations are performed either by the JRE’s default
|
||||
cryptographic provider by the [BouncyCastle](https://www.bouncycastle.org/)
|
||||
library (for AES-CCM encryption).
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
To build the library with [Maven](https://maven.apache.org/), first
|
||||
install the parent POM from my own repository by running
|
||||
|
||||
```
|
||||
$ mvn dependency:get -DgroupId=org.incenp -DartifactId=incenp-sjcl \
|
||||
-Dversion=1.1.0 -Dpackaging=pom \
|
||||
-DremoteRepositories=https://mvn.incenp.org/repo/releases
|
||||
```
|
||||
|
||||
You can then build the library by running, from the source directory
|
||||
Build the library with [Maven](https://maven.apache.org/) by running,
|
||||
from the source directory
|
||||
|
||||
```
|
||||
$ mvn package
|
||||
|
|
12
pom.xml
12
pom.xml
|
@ -1,11 +1,7 @@
|
|||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>org.incenp</groupId>
|
||||
<artifactId>incenp-base</artifactId>
|
||||
<version>1.1.0</version>
|
||||
</parent>
|
||||
|
||||
<groupId>org.incenp</groupId>
|
||||
<artifactId>incenp-sjcl</artifactId>
|
||||
<version>0.0.1-SNAPSHOT</version>
|
||||
<name>Incenp SJCL-compatible Java Crypto Library</name>
|
||||
|
@ -40,6 +36,10 @@
|
|||
<url>https://git.incenp.org/damien/sjcl/issues</url>
|
||||
</issueManagement>
|
||||
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.bouncycastle</groupId>
|
||||
|
@ -63,7 +63,7 @@
|
|||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-assembly-plugin</artifactId>
|
||||
<version>3.1.1</version>
|
||||
<version>3.3.0</version>
|
||||
<configuration>
|
||||
<descriptorRefs>
|
||||
<descriptorRef>jar-with-dependencies</descriptorRef>
|
||||
|
|
Loading…
Reference in New Issue