From 014a98ee4368f602545a3b23fdb3bd4833250873 Mon Sep 17 00:00:00 2001
From: hhf <hhf@noreply.localhost>
Date: Sun, 24 Nov 2024 21:37:35 +0530
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7681f7e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# CLI Formatter with Spinner
+
+This repository contains two scripts written in both `bash` and `python`, a `formatter` and an `example`, that work together to execute tasks with a spinner and formatted output. The `formatter` script provides functions for running tasks with a spinner, while the `example` script demonstrates how to use these functions by defining and executing a set of tasks or functions.
+
+There are slight differences between the `bash` and `python` versions with the python version being the further along.
+
+## Python Formatter
+
+[Python Files](https://github.com/seanssmith/CLI-Formatter/tree/main/python_task_importer)
+
+View the Package on [PyPi](https://pypi.org/project/TaskFormatter/)
+
+<details>
+  <summary>Example gif</summary>
+
+![](https://github.com/seanssmith/CLI-Formatter/blob/main/python_task_importer/pythonformatterexample.gif)
+
+</details>
+
+### To Do:
+- [ ] Add in handling for echo lines in function
+- [ ] Figure out a way to have print statements show up live rather than in bunches
+
+
+## Bash Formatter
+
+[Bash Files](https://github.com/seanssmith/CLI-Formatter/tree/main/bash_task_importer)
+
+<details>
+  <summary>Example gif</summary>
+  
+![](https://github.com/seanssmith/CLI-Formatter/blob/main/bash_task_importer/bashformatterexample.gif)
+
+</details>
+
+
+### To Do:
+- [ ] Add in global error handling
\ No newline at end of file