Extended Readme
This commit is contained in:
parent
ef6c4b0ea9
commit
851a2f827b
29
README.md
29
README.md
@ -1,9 +1,38 @@
|
|||||||
# Hasher
|
# Hasher
|
||||||
|
|
||||||
![GitHub](https://img.shields.io/github/license/cn-ml/hasher?logoColor=%23&style=for-the-badge)
|
![GitHub](https://img.shields.io/github/license/cn-ml/hasher?logoColor=%23&style=for-the-badge)
|
||||||
|
![PyPI](https://img.shields.io/pypi/v/hasher-cnml?style=for-the-badge)
|
||||||
|
|
||||||
Command line interface to the hashlib library.
|
Command line interface to the hashlib library.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Install hasher from [PyPI](https://pypi.org/project/hasher-cnml/).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install hasher-cnml
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Create a checksum (defaults to MD5) of the a sample file using:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m hasher file_to_hash.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
Or instead specify the hash algorithm directly (all algorithms from hashlib that are available locally)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m hasher -a sha1 file_to_hash.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
View the usage information:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m hasher -h
|
||||||
|
```
|
||||||
|
|
||||||
## Authors
|
## Authors
|
||||||
|
|
||||||
- [@cn-ml](https://www.github.com/cn-ml)
|
- [@cn-ml](https://www.github.com/cn-ml)
|
||||||
|
@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "hasher_cnml"
|
name = "hasher_cnml"
|
||||||
version = "0.0.1"
|
version = "0.0.2"
|
||||||
authors = [
|
authors = [
|
||||||
{ name="Michael Chen", email="mail@cnml.de" },
|
{ name="Michael Chen", email="mail@cnml.de" },
|
||||||
]
|
]
|
||||||
|
Loading…
Reference in New Issue
Block a user