From 57e76628e6331b4eebb1d309937cba1b186320b5 Mon Sep 17 00:00:00 2001 From: Tim Mikeladze Date: Thu, 23 May 2024 02:33:39 +0200 Subject: [PATCH] docs: improve readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 05dabc1..1af3d49 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ # 🏁 next-flag -Feature flags powered by GitHub issues and NextJS. Toggle the features of your app without deploying a new version purely through GitHub ticking a checkbox in an issue. Uses GitHub Webhooks, NextJS API Routes and the NextJS Cache under the hood to provide a totally free and easy-to-use feature flagging system for your NextJS app. +Feature flags powered by GitHub issues and NextJS. Toggle the features of your app without deploying a new version by ticking a checkbox in the body of a GitHub issue. + +## ✨ Features + +- [x] Enable or disable features by ticking a checkbox in a GitHub issue. +- [x] Use multiple environments or branches to control where the feature is enabled. +- [x] Supports React Server Side and Client Side Components. Powered by the NextJS Cache. +- [x] Can be deployed as a stand-alone service to manage feature flags for multiple NextJS apps. > Check-out a fully working [NextJS example](./examples/nextjs-example/) or jump to [Getting started](https://github.com/TimMikeladze/next-flag?tab=readme-ov-file#-getting-started).