From e3a3e42f7e896c72ef2990ad6033bceebe953dbd Mon Sep 17 00:00:00 2001 From: Brian Date: Wed, 23 Sep 2026 10:21:30 -0500 Subject: [PATCH] docs(readme): add website/docs nav and link to docs.flagward.com --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index d4f91ba..b7104e8 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,19 @@

+

+ Website +  ·  + Documentation +

+ # Flagward [![CI](https://github.com/basb7/flagward/actions/workflows/ci.yml/badge.svg)](https://github.com/basb7/flagward/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-informational.svg)](LICENSE) [![Python 3.14](https://img.shields.io/badge/python-3.14-blue.svg)](https://www.python.org/) [![Django 6.1](https://img.shields.io/badge/django-6.1-092E20.svg)](https://www.djangoproject.com/) +[![Docs](https://img.shields.io/badge/docs-docs.flagward.com-informational.svg)](https://docs.flagward.com) **Open-source feature flags with local SDK evaluation and real-time updates.** @@ -29,8 +36,15 @@ client in real time over SSE. > **not** safe for a deployment. Read [SECURITY.md](SECURITY.md#deployment-hardening) > before exposing an instance. +## Documentation + +The full documentation — guides, API reference, and SDK integration — lives at +**[docs.flagward.com](https://docs.flagward.com)**. This README covers only the +essentials to get Flagward running locally. + ## Table of Contents +- [Documentation](#documentation) - [Architecture](#architecture) - [Quick Start](#quick-start) - [Docker Compose](#docker-compose)