Changeset - 1e161ede44c5
[Not reviewed]
default
0 1 0
Laman - 3 years ago 2022-03-03 17:39:53

updated readme.md
1 file changed with 22 insertions and 2 deletions:
readme.md
22
2
0 comments (0 inline, 0 general)
readme.md
Show inline comments
 
@@ -4,9 +4,29 @@ Implements [Shamir's secret sharing algo
 

	
 
Outputs the shares as hexadecimal, Base32 or Base64 encoded strings.
 

	
 
## Installation and usage ##
 
## 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`.
 

	
 
## Usage
 

	
 
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`.
 
### 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. 
 

	
 
## Issue tracker
 
Please report your issues to https://trac.19x19.cz/shamira/report
 

	
 
## Performance ##
 

	
0 comments (0 inline, 0 general)