docs: Add local installation instructions

This release introduces detailed instructions for building and installing the LLM Commit Message VS Code extension locally.

- Provides prerequisites for development and usage.
- Includes step-by-step instructions for building the extension using npm.
- Offers guidelines for running the extension locally.

Author: MichaelCurrin

README.md

@@ -6,6 +6,10 @@
 
 This extensions adds a button to the Git extension sidebar - clicking it sends a Git diff to a local LLM (default Ollama) and uses a generated commit message in the box.
 
+## Note
+
+This extension is not available in the extensions library. You can build and install it locally though.
+
 ## Benefits
 
 - Free (does not require ChatGPT account and subscription)
@@ -14,11 +18,15 @@ This extensions adds a button to the Git extension sidebar - clicking it sends a
 
 ## Documentation
 
-See [docs](/docs/) for more details.
+[Docs website](https://michaelcurrin.github.io/llm-commit-msg-vs-code/)
 
 ## Sample
 
-![SCM action button](./sample.png)
+<div align="center">
+    <img src="https://github.com/MichaelCurrin/llm-commit-msg-vs-code/raw/docs/sample.png"
+        alt="sample screenshot"
+        width="300" />
+</div>
 
 ## Related projects
 
@@ -27,4 +35,4 @@ See [docs](/docs/) for more details.
 
 ## License
 
-Licensed under [MIT](/LICENSE).
+Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).

docs/README.md

@@ -2,9 +2,9 @@ LLM Commit Message – Documentation
 
 This VS Code extension generates high‑quality Git commit messages using a local LLM exposed via an OpenAI‑compatible API (e.g. Ollama).
 
-- [Installation](docs/installation.md)
-- [Usage](docs/usage.md)
-
+- [Installation](installation.md)
+- [Usage](usage.md)
+- [Development](development/)
 
 ## Quickstart
 

docs/development/README.md

@@ -0,0 +1,4 @@
+# Development
+
+- [Back to user docs](../)
+- [Installation](installation.md)

docs/development/installation.md

@@ -0,0 +1,27 @@
+# Installation
+
+# Prerequisites
+
+- **VS Code** `^1.104.0`.
+- **Git** installed and a Git repository opened in VS Code.
+- **Ollama** (or another OpenAI‑compatible server) running and reachable at `http://localhost:11434/v1`.
+
+## Ollama setup (example)
+
+- Install Ollama and ensure the OpenAI‑compatible endpoint is running.
+- Pull or run a model that matches your settings, e.g. `gemma3`:
+  - `ollama pull gemma3`
+  - `ollama run gemma3`
+
+## Configure the extension
+
+- Open VS Code Settings and search for `LLM Commit Message`.
+- Set:
+  - `llmCommitMsg.endpoint` (default `http://localhost:11434/v1`).
+  - `llmCommitMsg.model` (default `gemma3`).
+
+Install from source (development)
+
+- Clone this repository.
+- Open it in VS Code and press `F5` to launch an Extension Development Host.
+- In the Extension Development Host, open a Git repository and use the command from the Source Control view (see Usage).

docs/installation.md

@@ -1,27 +1,29 @@
 # Installation
+> Guide for end users to build and install the extension locally.
 
-# Prerequisites
+## Prerequisites
 
 - **VS Code** `^1.104.0`.
-- **Git** installed and a Git repository opened in VS Code.
-- **Ollama** (or another OpenAI‑compatible server) running and reachable at `http://localhost:11434/v1`.
+- **Node.js** and **npm**.
+- Optional: **Ollama** (or any OpenAI‑compatible server) if you plan to use the extension.
 
-## Ollama setup (example)
+## Steps
 
-- Install Ollama and ensure the OpenAI‑compatible endpoint is running.
-- Pull or run a model that matches your settings, e.g. `gemma3`:
-  - `ollama pull gemma3`
-  - `ollama run gemma3`
+Clone the repo.
 
-## Configure the extension
+Install dependencies:
 
-- Open VS Code Settings and search for `LLM Commit Message`.
-- Set:
-  - `llmCommitMsg.endpoint` (default `http://localhost:11434/v1`).
-  - `llmCommitMsg.model` (default `gemma3`).
+```bash
+npm ci
+```
 
-Install from source (development)
+Package the extension (creates a `.vsix` in the current directory):
 
-- Clone this repository.
-- Open it in VS Code and press `F5` to launch an Extension Development Host.
-- In the Extension Development Host, open a Git repository and use the command from the Source Control view (see Usage).
+```bash
+npm run ext
+```
+
+## Run for development (no install)
+
+- Open the repo in VS Code and press `F5` to launch an Extension Development Host.
+- Use the command palette or Source Control view to trigger the extension command.