Changeset - 617dc4a93c4c
[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:
0 comments (0 inline, 0 general)
README.md
Show inline comments
 
@@ -8,13 +8,13 @@ Outputs the shares as hexadecimal, Base3
 

	
 
### 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.
 
@@ -57,6 +57,10 @@ Benchmark results, as obtained by runnin
 
    <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)