From 049f579eb5dd991a89643294979c2afed160ad47 Mon Sep 17 00:00:00 2001 From: ION606 Date: Sat, 15 Feb 2025 03:46:16 +0000 Subject: [PATCH] Create README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d52f0b6 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# ION Static Site Hosting + +ION Static Site Hosting is a lightweight Python application designed to serve static websites effortlessly. Built with Flask, it allows developers to deploy HTML, CSS, JavaScript, and image files quickly, making it ideal for personal projects, documentation, or simple web pages. + +## Features +- Easy usage +- Sleek and simple UI +- Syntax highlighting/In-browser code editor +- Default dark mode!!! + +## Self-Hosting? +Just clone the repo, then use the following to get started: +```bash +python -m venv .venv +# Activate the env (use .venv/bin/activate.fish for fish) +source .venv/bin/activate +pip install -r requirements.txt +python app.py +``` +And that's it! The app should be available at http://localhost:5000 + +## Contributing + +Contributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.