From 851a2f827b8dddbeda0170cbabb58f1c71bb001f Mon Sep 17 00:00:00 2001 From: Michael Chen Date: Mon, 17 Apr 2023 14:38:38 +0200 Subject: [PATCH] Extended Readme --- README.md | 29 +++++++++++++++++++++++++++++ pyproject.toml | 2 +- 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2d62fbd..854a091 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,38 @@ # Hasher ![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. +## 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 - [@cn-ml](https://www.github.com/cn-ml) diff --git a/pyproject.toml b/pyproject.toml index f7ecd5a..ff484df 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "hasher_cnml" -version = "0.0.1" +version = "0.0.2" authors = [ { name="Michael Chen", email="mail@cnml.de" }, ]