From 2953cc024f2e97c2862104b914b3115fe6e3f251 Mon Sep 17 00:00:00 2001
From: Steven Crawford <steven@shelbybark.com>
Date: Thu, 12 Dec 2024 13:44:36 -0600
Subject: [PATCH] added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..44a4e84
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# split_zip_into_smaller_chunks.py
+
+A simple python script to split a Zip file into smaller chunks. 
+
+Script will ask for the size, in Gigabytes, of the new files. And it will ask for the filename of the input file (can be in the same directory or you can enter a path to the file).
+
+## Installation
+
+Download script to a preferable location. I like to symlink it to a bin directory I have created.
+```bash
+ln -s /path/to/split_zip_into_smaller_chunks.py ~/bin/split_zip_into_smaller_chunks
+```
+
+## Usage
+
+```bash
+~/bin/split_zip_into_smaller_chunks
+Enter the maximum (in GB) zipped file size (2 is default): 1.6
+Enter the path to the zipped file: enewscourier.com_archive_2016.zip
+```
+
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)