Skip to content

Commit f5c0f0d

Browse files
Merge pull request #441 from harshsingh32/patch-1
Update README
2 parents ae4bbf0 + 316706c commit f5c0f0d

1 file changed

Lines changed: 39 additions & 5 deletions

File tree

encrypt_string/README

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
This script can hash strings using following hashing algorithms:
1+
## Encrypt String Script
2+
3+
This script provides the capability
4+
to hash strings using various hashing
5+
algorithms, making it useful for
6+
encryption and security purposes.
7+
The following hashing algorithms
8+
are supported:
29

310
1. SHA224
411
2. SHA256
@@ -12,7 +19,34 @@ Input is accepted through a text file (not a binary)
1219
The hashed string is written in a file named "hashed.txt" in the present working directory.
1320

1421

15-
HOW TO RUN?
16-
1. Locate to the directory where the script is stored
17-
2. execute command "python ./string_hashing.py"
18-
22+
## How to Use?
23+
1.Input: The script accepts input through a text file containing the string you want to hash. Please note that it only accepts text files, not binary files.
24+
25+
2.Output: The hashed string is written to a file named "hashed.txt" in the present working directory.
26+
27+
28+
## Running the Script
29+
1.To run the script, follow these steps:
30+
31+
2. Locate the Script: Navigate to the directory where the script is stored.
32+
33+
3. Execute the Script: Use the following command to execute the script:
34+
35+
``
36+
python ./string_hashing.py
37+
``
38+
## Important Note
39+
40+
Hashing is a one-way process, meaning you cannot
41+
reverse-engineer the original string from the hash. It is commonly
42+
used for securely storing passwords and verifying data integrity.
43+
44+
## Contributing
45+
Contributions to this project are welcome! If you have ideas for new features, improvements, or bug fixes, feel free to fork the repository and submit a pull request.
46+
47+
## License
48+
This project is open-source and available under the MIT License. See the LICENSE file for more details.
49+
50+
Let's use this script to enhance security and encryption in our projects! 🔐✨
51+
52+

0 commit comments

Comments
 (0)