docs: add README.md

ant-design · Dec 28, 2023 · cdc16d3 · cdc16d3
1 parent 5f8a09c
commit cdc16d3
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,34 @@
+# @ant-design/nextjs-registry
+
+This package is used for registry styles of Ant Design components for Next.js.
+
+## Install
+
+```bash
+npm install @ant-design/nextjs-registry --save
+```
+
+## Usage
+
+Should be use in `RootLayout` of Nextjs app router.
+
+```tsx
+// app/layout.tsx
+
+import React from 'react';
+import { AntdRegistry } from '@ant-design/nextjs-registry';
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html lang="en">
+      <body>
+        <AntdRegistry>{children}</AntdRegistry>
+      </body>
+    </html>
+  );
+}
+```