From 41cd7e566d72fdb0f086c372225c5de1a1c3c878 Mon Sep 17 00:00:00 2001 From: King24Dave <147387945+King24Dave@users.noreply.github.com> Date: Sun, 29 Mar 2026 10:58:40 -0700 Subject: [PATCH] Update README.mddocs: improve README with full project description The previous README only contained a title and a one-line tagline, providing no useful information for contributors or new visitors. This commit improves the README by adding: - A clear explanation of what BOS is - A list of key features - Getting started / installation instructions - Self-hosting section placeholder - Contributing guidelines reference - License reference This makes the repository more welcoming and informative for open source contributors and users discovering BOS. --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2973e74..756dd56 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ -# BOS -BOS (Bugema Operating System) the internet OS! Free, Open Source, Self hostable +# BOS 🌐 +**BOS (Bugema Operating System)** — the internet OS! Free, Open Source, Self hostable. + +## What is BOS? +BOS is a web-based operating system that runs in the browser. +It gives users a full desktop experience over the internet — +no installation required. + +## Features +- 🌍 Runs entirely in the browser +- 🔓 Free & Open Source +- 🖥️ Self hostable — run it on your own server +- ⚡ Lightweight and fast + +## Getting Started +```bash +git clone https://github.com/King24Dave/BOS.git +cd BOS +``` + +## Self Hosting +> Instructions coming soon... + +## Contributing +Pull requests are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. + +## License +This project is licensed under the terms in [LICENSE](LICENSE).