docs: update docs

TimMikeladze · May 23, 2024 · 9ba5358 · 9ba5358
1 parent 57e7662
commit 9ba5358
Show file tree

Hide file tree

Showing 4 changed files with 173 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -85,6 +85,7 @@ Finally, let's write some code to use the `next-flag` package.
 ```ts
 // src/app/api/next-flag/nf.ts
 import { NextFlag } from 'next-flag';
+import { revalidateTag, unstable_cache } from 'next/cache';
 
 export const nf = new NextFlag({
   paths: [
@@ -93,6 +94,10 @@ export const nf = new NextFlag({
       issue: 123,
     },
   ],
+  cache: {
+    revalidateTag,
+    unstable_cache,
+  },
 });
 ```
 
@@ -249,6 +254,7 @@ NEXT_PUBLIC_NEXT_FLAG_ENDPOINT="https://<YOUR_DOMAIN>/api/next-flag"
 ```ts
 // src/app/api/next-flag/nf.ts
 import { NextFlag } from 'next-flag';
+import { revalidateTag, unstable_cache } from 'next/cache';
 
 export const nf = new NextFlag({
   paths: [
@@ -263,6 +269,10 @@ export const nf = new NextFlag({
       issue: 124,
     },
   ],
+  cache: {
+    revalidateTag,
+    unstable_cache,
+  },
 });
 ```
 

diff --git a/examples/nextjs-example/package.json b/examples/nextjs-example/package.json
@@ -9,16 +9,17 @@
     "lint": "next lint"
   },
   "dependencies": {
+    "next": "14.2.3",
+    "next-flag": "^0.0.1",
     "react": "^18",
-    "react-dom": "^18",
-    "next": "14.2.3"
+    "react-dom": "^18"
   },
   "devDependencies": {
-    "typescript": "^5",
     "@types/node": "^20",
     "@types/react": "^18",
     "@types/react-dom": "^18",
     "eslint": "^8",
-    "eslint-config-next": "14.2.3"
+    "eslint-config-next": "14.2.3",
+    "typescript": "^5"
   }
 }
diff --git a/examples/nextjs-example/pnpm-lock.yaml b/examples/nextjs-example/pnpm-lock.yaml
diff --git a/examples/nextjs-example/src/app/api/next-flag/nf.ts b/examples/nextjs-example/src/app/api/next-flag/nf.ts
@@ -1,4 +1,5 @@
 import { NextFlag } from 'next-flag';
+import { revalidateTag, unstable_cache } from 'next/cache';
 
 export const nf = new NextFlag({
   paths: [
@@ -7,4 +8,8 @@ export const nf = new NextFlag({
       issue: 3,
     },
   ],
+  cache: {
+    revalidateTag,
+    unstable_cache,
+  },
 });