Skip to content

Commit

Permalink
docs: add video to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TimMikeladze authored May 23, 2024
1 parent f267538 commit 742399f
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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.

![architecture](./docs/architecture.png)
> 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).
## 📡 Install

Expand All @@ -16,9 +16,15 @@ pnpm add next-flag

> 👋 Hello there! Follow me [@linesofcode](https://twitter.com/linesofcode) or visit [linesofcode.dev](https://linesofcode.dev) for more cool projects like this one.
## 🚀 Getting started
## 🛠️ Architecture

![architecture](./docs/architecture.png)

> Check-out a complete [NextJS example](./examples/nextjs-example/).
## 🎥 Demo

https://github.com/TimMikeladze/next-flag/assets/702718/d1707ae0-f9cf-4f80-a20f-6a6f9f715dc2

## 🚀 Getting started

### 📄 Create a new issue

Expand Down

0 comments on commit 742399f

Please sign in to comment.