From eedce107a42d42e707b2581c7e6053d952a70788 Mon Sep 17 00:00:00 2001
From: Damian <34820479+mt1006@users.noreply.github.com>
Date: Thu, 21 Apr 2022 21:16:58 +0200
Subject: [PATCH] Add files via upload

---
 README.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 91 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0cce88
--- /dev/null
+++ b/README.md
@@ -0,0 +1,91 @@
+# About
+
+checkHash is a simple command line tool that allows you to easily get file checksum, compare multiple files or compare file checksum to checksum on input.
+
+
+# Example
+
+```
+F:\>ch file1.txt
+file_sha256("file1.txt") = ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad
+
+F:\>ch file1.txt file2.txt
+file_sha256("file1.txt") = ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad
+file_sha256("file2.txt") = 9834876dcfb05cb167a5c24953eba58c4ac89b1adf57f28f2f9d09af107ee8f0
+[NOT EQUAL]
+
+F:\>ch file1.txt ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad
+file_sha256("file1.txt") = ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad
+[EQUAL]
+
+F:\>ch -f md5 file1.txt
+file_md5("file1.txt") = 900150983cd24fb0d6963f7d28e17f72
+
+F:\>ch file1.txt 900150983cd24fb0d6963f7d28e17f72
+file_md5("file1.txt") = 900150983cd24fb0d6963f7d28e17f72
+[EQUAL]
+```
+
+
+# List of Options
+```
+ [none] / -c         Get file hash and compare it to hash or hash of other file
+  (--compare)        Comparing is optional. If you don't want to compare, enter only the one filename.
+                     If you want to compare, enter a filename or hash.
+                     Based on the used characters and the length of the second input,
+                     it automatically determines whether it is a file or a hash and what type of hash.
+                     If you want to be sure about the interpretation of the input, use -cf or -ch.
+                     You can also use -f to select the hash function.
+                     Examples:
+                      ch file1.txt
+                      ch file1.txt file2.txt
+                      ch file1.txt ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad
+ -g                  Get the hash for each file from input.
+  (--get-hash)       Calculates a hash for each input file.
+                     Examples:
+                      ch -g file1.txt file2.txt file3.txt
+ -s [strings]        Hash of string.
+  (--string-hash)    Calculates the hash for string or strings.
+                     Examples:
+                      ch -s "Example string"
+                      ch -s "First string" "Second string"
+ -cf                 Get file hash and compare it to hash of other file
+  (--compare-files)  Similar to -c, but takes the second argument always as a filename.
+                     Examples:
+                      ch -cf file1.txt file2.txt
+ -ch                 Get file hash and compare it to hash on input
+  (--compare-hashes) Similar to -c, but takes the second argument always as a hash.
+                     Unlike -c it does not automatically detect the type of hash function when neither is set.
+                     It uses SHA-256 by default.
+                     Examples:
+                      ch -ch file1.txt ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad
+ -f [function]       Sets the selected hash function.
+  (--hash-function)  Default hash function is SHA-256.
+                     To get list of all available hash functions,
+                     use the -f option without any additional arguments.
+                     Examples:
+                      ch -f
+                      ch -f md5 file1.txt
+                      ch -f sha512 -g file1.txt file2.txt
+ -so                 Simple output.
+  (--simple-output)  Simplifies the output.
+                     When comparing, it gives 1 at the end when equal or 0 when different.
+                     Examples:
+                      ch -so file1.txt file2.txt
+                      ch -h -so file1.txt file2.txt file3.txt
+ -i (--information)  Information about checkHash.
+ -fi(--full-info)    Full info about checkHash.
+ -v (--version)      Information about checkHash version.
+ -h / -? (--help)    Display this help message.
+```
+
+# Available Hash Functions
+
+- **SHA1**
+- SHA2: **SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256**
+- SHA3: **SHA3-224, SHA3-256, SHA3-384, SHA3-512**
+- MD: **MD4, MD5**
+- BLAKE: **BLAKE2b-512, BLAKE2s-256**
+- RIPEMD: **RIPEMD-160**
+- **WHIRLPOOL**
+- **SM3**
\ No newline at end of file