From 27c2cbb15505c4f3e7981f221b694e07ddf71dcc Mon Sep 17 00:00:00 2001 From: Mayank Kumar Chaudhari Date: Sat, 20 Apr 2024 10:24:04 +0530 Subject: [PATCH] Copy readme for docs --- lib/r18gs/README.md | 4 +++- lib/r18gs/package.json | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/r18gs/README.md b/lib/r18gs/README.md index 718ce322..6c6724c8 100644 --- a/lib/r18gs/README.md +++ b/lib/r18gs/README.md @@ -1,6 +1,6 @@ # React18GlobalStore -[![test](https://github.com/react18-tools/react18-global-store/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/react18-global-store/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/ec3140063acd8df82481/maintainability)](https://codeclimate.com/github/react18-tools/react18-global-store/maintainability) [![codecov](https://codecov.io/gh/react18-tools/react18-global-store/graph/badge.svg)](https://codecov.io/gh/react18-tools/react18-global-store) [![Version](https://img.shields.io/npm/v/r18gs.svg?colorB=green)](https://www.npmjs.com/package/r18gs) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/dt/r18gs.svg)](https://www.npmjs.com/package/r18gs) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/r18gs) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/) +[![test](https://github.com/react18-tools/react18-global-store/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/react18-global-store/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/ec3140063acd8df82481/maintainability)](https://codeclimate.com/github/react18-tools/react18-global-store/maintainability) [![codecov](https://codecov.io/gh/react18-tools/react18-global-store/graph/badge.svg)](https://codecov.io/gh/react18-tools/react18-global-store) [![Version](https://img.shields.io/npm/v/r18gs.svg?colorB=green)](https://www.npmjs.com/package/r18gs) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/r18gs.svg)](https://www.npmjs.com/package/r18gs) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/r18gs) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/) ## Motivation @@ -16,6 +16,8 @@ Thus, I decided to create a bare minimum, ultra-light store that creates shared ✅ Works with all build systems/tools/frameworks for React18 +✅ Works for both client side and server side components (be careful, separate states are created for server side and client side. Any changes done on client side will not affect the server components.) + ✅ Doccumented with [Typedoc](https://react18-tools.github.io/react18-global-store) ([Docs](https://react18-tools.github.io/react18-global-store)) ✅ Next.js, Vite and Remix examples diff --git a/lib/r18gs/package.json b/lib/r18gs/package.json index 69dbfb73..bde6abb9 100644 --- a/lib/r18gs/package.json +++ b/lib/r18gs/package.json @@ -19,7 +19,7 @@ "scripts": { "test": "vitest run --coverage", "build": "tsup src && tsc -p tsconfig-build.json && node touchup.js", - "doc": "typedoc", + "doc": "cp ../../README.md . && typedoc", "publish-package": "cd dist && npm publish --provenance --access public", "lint": "eslint ." },