From b9e1f706c588d0dea2b4fdb40e2f012196a24548 Mon Sep 17 00:00:00 2001
From: Noah <otikanoahjunior9@gmail.com>
Date: Tue, 21 Apr 2026 13:06:51 +0300
Subject: [PATCH] docs: add installation, usage and configuration guides
 (closes #3)

---
 docs/configuration.md | 13 +++++++++++++
 docs/installation.md  | 27 +++++++++++++++++++++++++++
 docs/usage.md         | 13 +++++++++++++
 3 files changed, 53 insertions(+)
 create mode 100644 docs/configuration.md
 create mode 100644 docs/installation.md
 create mode 100644 docs/usage.md

diff --git a/docs/configuration.md b/docs/configuration.md
new file mode 100644
index 0000000..f8ba6ee
--- /dev/null
+++ b/docs/configuration.md
@@ -0,0 +1,13 @@
+# Configuration Guide
+
+## Environment Variables
+
+| Variable | Description | Default |
+|---|---|---|
+| `PORT` | Port the server runs on | `8000` |
+| `DEBUG` | Enable debug mode | `false` |
+| `SECRET_KEY` | Application secret key | (required) |
+| `DATABASE_URL` | Database connection string | (required) |
+
+## Setting up .env
+Create a `.env` file in the root directory and fill in the values above.
\ No newline at end of file
diff --git a/docs/installation.md b/docs/installation.md
new file mode 100644
index 0000000..91494a7
--- /dev/null
+++ b/docs/installation.md
@@ -0,0 +1,27 @@
+# Installation Guide
+
+## Prerequisites
+- Git installed on your machine
+- A server or local machine to self-host
+
+## Steps
+
+### 1. Clone the repository
+```bash
+git clone https://github.com/bos-com/BOS.git
+cd BOS
+```
+
+### 2. Configure environment
+Copy the example environment file and edit it:
+```bash
+cp .env.example .env
+```
+
+### 3. Run the application
+```bash
+# Instructions will be added as the project develops
+```
+
+## Troubleshooting
+Open an issue at https://github.com/bos-com/BOS/issues if you encounter problems.
\ No newline at end of file
diff --git a/docs/usage.md b/docs/usage.md
new file mode 100644
index 0000000..8a39aab
--- /dev/null
+++ b/docs/usage.md
@@ -0,0 +1,13 @@
+# Usage Guide
+
+## Starting BOS
+Once installed, BOS can be accessed via your browser at `http://localhost:8000`
+
+## Self-hosting
+BOS is designed to be self-hostable. You can deploy it on:
+- A personal VPS (e.g. DigitalOcean, Linode)
+- A local server on your network
+- A cloud provider (AWS, GCP, Azure)
+
+## Configuration
+See [configuration.md](./configuration.md) for all available options.
\ No newline at end of file