From e7ef43a7ba486416ea0457b5da3839d5455f5a55 Mon Sep 17 00:00:00 2001
From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com>
Date: Thu, 10 Jul 2025 10:55:07 -0400
Subject: [PATCH] docs: add quick start and config instructions

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 1ec4dad..be0009d 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,18 @@ Built with Node.js (using libraries like Eleventy for templating, `marked` or `r
 
 This final spec incorporates core features, enhancements for usability and performance, and explicit user instructions. It's designed to be implemented as an open-source GitHub repo with a CLI starter kit (e.g., `npx create-docforge my-site`).
 
+## Quick Start
+
+```bash
+# install dependencies and start the dev server
+npm install
+npm run dev
+
+# build the static site
+npm run build
+```
+
+
 ## Key Features
 
 - **Markdown-Driven Content and Navigation**:
@@ -156,6 +168,10 @@ To make DocForge truly user-friendly, include these instructions in the starter
 - **Multi-Version**: Prefix folders like `content/v1/`, `content/v2/`; config enables switcher.
 - **Multi-Language (Optional)**: Use `content/en/`, `content/fr/` if `features.i18n: true`; add lang switcher.
 
+### Configuring Versions and Languages
+- Add available versions under `navigation.versions` in `config.yaml` and create matching folders (e.g., `content/v1/`, `content/v2/`).
+- Enable multiple languages by setting `features.i18n: true` and using subfolders such as `content/en/` or `content/fr/`.
+
 ### Formatting Markdown Content
 - **Basics**: Use standard Markdown:
   - `# Heading 1` for main titles (auto-generates page TOC).