From be4e05bdb5a804b075809c2e7e010b3988a4ad3a Mon Sep 17 00:00:00 2001
From: afc163 <afc163@gmail.com>
Date: Mon, 23 Sep 2024 14:39:52 +0800
Subject: [PATCH] Add extractStyle API description to README (#196)

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index c7155ee..6e8a60c 100644
--- a/README.md
+++ b/README.md
@@ -75,6 +75,39 @@ Create theme object. When same algorithm provided, it will return same object.
 
 Since `@ant-design/cssinjs` use strong constraints for cache hit performance, we recommend to view demo `basic.tsx` for usage and `animation.tsx` for animation usage.
 
+### extractStyle
+
+Extracts the styles from the cache and returns them as a string.
+
+#### Parameters
+
+- `cache` (Cache): The cache instance containing the styles.
+- `options` (object | boolean, optional): Options for extracting the styles.
+  - `plain` (boolean, optional): If true, the styles will be returned in plain format. Default is false.
+  - `types` (string | string[], optional): The types of styles to extract. Default is ['style', 'token', 'cssVar'].
+
+#### Returns
+
+- (string): The extracted styles as a string.
+
+#### Example
+
+```typescript
+import { extractStyle, createCache } from '@ant-design/cssinjs';
+
+// 创建并填充缓存
+const cache = createCache();
+// 注意：在实际使用中，缓存通常会在渲染组件时自动填充
+
+// 提取样式
+const styles = extractStyle(cache, { plain: true, types: ['style', 'token'] });
+
+// 使用提取的样式
+const styleElement = document.createElement('style');
+styleElement.innerHTML = styles;
+document.head.appendChild(styleElement);
+```
+
 ## Transform
 
 When you need transform CSSObject before inject style. You can use `transformers` to handle this: