Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ythepaut committed Apr 29, 2024
1 parent e2e6097 commit 2262434
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
# Occult Crypto Library

[![License](https://img.shields.io/github/license/occult-app/crypto?style=for-the-badge)](https://github.com/occult-app/crypto/blob/master/LICENSE)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/occult-app/crypto/test.yml?style=for-the-badge)](https://github.com/occult-app/crypto/actions)
[![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/occult-app_crypto?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/project/overview?id=occult-app_crypto)
[![Sonar Coverage](https://img.shields.io/sonar/coverage/occult-app_crypto?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/project/overview?id=occult-app_crypto)

Occult's client library. It encompasses all cryptographic operations and processes outlined in the [security whitepaper](https://docs.google.com/document/d/1dV4tq5osFdlw7ICn_SS-hcaO9wuRlCqD_wv8IKnSgb8/edit?usp=sharing).

## Usage

```shell
npm install @occult-app/crypto
```

A standalone file [occult-app-crypto.js](https://github.com/occult-app/crypto/releases) is also available.

## About

### License

GNU GPL v3.0 License

See [LICENSE](https://github.com/occult-app/crypto/blob/master/LICENSE) file.

### Authors

**The Occult Team** :

* Ewan Rakotoanosy - [@rakotoew](https://github.com/rakotoew)
* Romain Theodet - [@RomainTHD](https://github.com/RomainTHD)
* Yohann Thepaut - [@ythepaut](https://github.com/ythepaut)

0 comments on commit 2262434

Please sign in to comment.