Shamira Changeset - 617dc4a93c4c

Changeset - 617dc4a93c4c

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Laman - 3 years ago 2022-03-04 17:53:55

updated README

1 file changed with 5 insertions and 1 deletions:

README.md

0 comments (0 inline, 0 general)

README.md

➞

Show inline comments

@@ @@ -2,25 +2,25 @@ @@
 Implements [Shamir's secret sharing algorithm](https://en.wikipedia.org/wiki/Shamir's_Secret_Sharing). Splits a string or a byte sequence byte-per-byte into _n_<255 shares, with any _k_ of them sufficient for reconstruction of the original input.
 Outputs the shares as hexadecimal, Base32 or Base64 encoded strings.
 ## Installation ##
 ### From pip
 Run `pip install shamira`.
 ### From the source
-Can be run straight from the cloned repository by executing the package with `python -m shamira` or simply installed with `python setup.py build`, `python setup.py install`. Then imported in your code with `import shamira` or run from the command line with `shamira`.
+Can be run straight from the cloned repository by executing the package with `python -m shamira` or built with `python -m build` and installed with `pip install dist/shamira*.whl`.
 ## Usage
 ### As a CLI application
 Run `shamira split ...` for splitting and `shamira join ...` for joining the shares back. Appending `--help` will show you the documentation.
 ### As a library
 `from shamira import generate, generate_raw, reconstruct, reconstruct_raw`
 `help(function)` will show the documentation.
@@ @@ -51,12 +51,16 @@ Benchmark results, as obtained by runnin @@
     </tr>
     <tr>
         <td>254 / 254 (a Raspberry Pi 3)</td>
         <td>0.0268</td>
         <td>0.0287</td>
     </tr>
     <tr>
         <td>254 / 254 (a laptop)</td>
         <td>0.00183</td>
         <td>0.00156</td>
     </tr>
 </table>
 ## License ##
 The code is licensed under GNU GPL v3. If this doesn't fit your needs, reach me and we can negotiate relicensing.

0 comments (0 inline, 0 general)