Skip to content
This repository was archived by the owner on Apr 2, 2026. It is now read-only.

Commit 3c30fd2

Browse files
committed
Updated readme with new license and library usage
1 parent 20283ad commit 3c30fd2

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,28 @@ java -jar secrete.jar -i <encrypted_file> -o <decrypted_file> decrypt
8383

8484
Insert the password to unlock the private key.
8585

86+
## Library usage
87+
88+
Secrete can be used as a library, via the [Maven Central Repository](https://mvnrepository.com/artifact/net.nharyes/secrete):
89+
90+
```xml
91+
<dependency>
92+
<groupId>net.nharyes</groupId>
93+
<artifactId>secrete</artifactId>
94+
</dependency>
95+
```
96+
97+
The main classes to use are:
98+
99+
* `net.nharyes.secrete.curve.Curve25519KeyPairGenerator`
100+
* `net.nharyes.secrete.ecies.ECIESHelper`
101+
102+
Check the [ECIESHelper unit tests](https://github.com/gherynos/secrete/blob/main/src/test/java/net/nharyes/secrete/ecies/TestECIESHelper.java#L34) for some usage examples.
103+
86104
## Author
87105

88106
> GitHub [@gherynos](https://github.com/gherynos)
89107
90108
## License
91109

92-
Secrete is licensed under the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html).
110+
Secrete is licensed under the [Apache License 2.0](https://apache.org/licenses/LICENSE-2.0) since version `1.0.2`.

0 commit comments

Comments
 (0)