Merge pull request #9 from vikiboss/docs/add-faq

docs: add FAQ about readonly hack
sheinsight · Sep 15, 2023 · d081355 · d081355
2 parents 835fa1a + 432f443
commit d081355
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -131,11 +131,24 @@ export default function Foo() {
 }
 ```
 
+## FAQ
+
+### TS type error, `readonly` type can not be assigned to mutable type
+
+This error commonly occurs when using [shineout](https://github.com/sheinsight/shineout), [antd](https://github.com/ant-design/ant-design) or other UI component libraries.
+
+To resolve this issue, add following code to your entry file, and you can head to [PR#8](https://github.com/sheinsight/reactive/pull/8) for more details.
+
+```ts
+// add this line to your entry file, like `index.tsx`, `global.d.ts` or ect.
+import "@shined/reactive/hack-remove-readonly";
+```
+
 ## Examples
 
 - [base-example](https://stackblitz.com/edit/vitejs-vite-zli31f?file=src%2Fmain.tsx)
 - [multi-store-example](https://stackblitz.com/edit/vitejs-vite-n5azuk?file=src%2Fmain.tsx)
 
 ## License
 
-- [MIT](LICENSE)
+- [MIT](./LICENSE)
diff --git a/packages/reactive/package.json b/packages/reactive/package.json
@@ -13,7 +13,8 @@
     "test:cov": "vitest run --coverage"
   },
   "files": [
-    "dist"
+    "./dist",
+    "./hack-remove-readonly.d.ts"
   ],
   "exports": {
     ".": {