diff --git a/README.md b/README.md new file mode 100644 index 0000000..0d5e342 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# GetEndpoints + +## Prerequisites + +- `python >= 3.11` +- `python-venv` + +## Usage + +1. Open the terminal. + +2. Navigate to the project directory. + +3. Run the application: + + ```bash + bash run.sh + ```