Skip to content

Commit

Permalink
docs: add lang to codeblocks (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
sidsbrmnn authored Nov 20, 2022
1 parent f683cc3 commit 204bfb7
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# pyshamir

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=konidev20_pyshamir&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=konidev20_pyshamir)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=konidev20_pyshamir&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=konidev20_pyshamir)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=konidev20_pyshamir&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=konidev20_pyshamir)
Expand All @@ -9,14 +10,16 @@
Python port of Shamir key Split and Combine methods from Hashicorp Vault.

## Installation
```

```sh
pip install pyshamir
```

## Usage

### Split & Combine
```

```py
from pyshamir import split, combine
import secrets

Expand All @@ -37,5 +40,6 @@ recomb_secret = combine(parts)
```

## References

1. [Shamir Secret Sharing | Wikipedia](https://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing)
2. [Go Implementation | HashiCorp Vault](https://github.com/hashicorp/vault/tree/main/shamir)

0 comments on commit 204bfb7

Please sign in to comment.