diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index 7df0cfc7..f2cce950 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -10,7 +10,7 @@ jobs:
publish:
# Don't run just after creating repo from template
# Also avoid running after merging set-up PR
- if: github.run_number > 2 && github.event.repository.owner.login == 'react18-tools'
+ if: github.event.repository.owner.login == 'react18-tools'
runs-on: ubuntu-latest
permissions:
packages: write
@@ -48,10 +48,16 @@ jobs:
- name: Publish Scoped package to NPM
# continue on error - expecing npm to trow error if scoping is done twice
continue-on-error: true
- id: publish_scoped
run: cd dist && node ../scope.js && npm publish --provenance --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
TOKEN: ${{ secrets.GITHUB_TOKEN }}
OWNER: ${{ github.event.repository.owner.login }}
REPO: ${{ github.event.repository.name }}
+
+ - name: Publish package with long name for better SEO
+ continue-on-error: true
+ run: |
+ cd dist
+ sed -i -e "s/.*name.*/\t\"name\": \"react18-global-store\",/" package.json
+ npm publish --provenance --access public
diff --git a/README.md b/README.md
index c79abe0d..27299853 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# React18GlobalStore
-[![test](https://github.com/react18-tools/r18gs/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/r18gs/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/react18-tools/r18gs/maintainability) [![codecov](https://codecov.io/gh/react18-tools/r18gs/graph/badge.svg)](https://codecov.io/gh/react18-tools/r18gs) [![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/r18gs/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/r18gs/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/41f10c0e6846d1e8a56b/maintainability)](https://codeclimate.com/github/react18-tools/r18gs/maintainability) [![codecov](https://codecov.io/gh/react18-tools/r18gs/graph/badge.svg)](https://codecov.io/gh/react18-tools/r18gs) [![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/)
## Motivation
@@ -24,6 +24,8 @@ Thus, I decided to create a bare minimum, ultra-light store that creates shared
## Install
+> A canonical package with longer name is also published `react18-global-store`
+
```bash
$ pnpm add r18gs
```
@@ -40,53 +42,6 @@ or
$ yarn add r18gs
```
-## Step by Step Instructions and Checklist
-
-- [ ] Set up `CodeCov`
- - [ ] Visit codecov and setup your repo
- - [ ] Create repository secrets for `CODECOV_TOKEN`
-- [ ] Set up `CodeClimate`
- - [ ] Visit CodeClimate and setup your repo
- - [ ] Create repository secrets for `CC_TEST_REPORTER_ID`
- - [ ] add `*.test.*` to ignore patterns on the website
- - [ ] update code climate badge
-- [ ] Add `NPM_AUTH_TOKEN` to repository secrets to automate publishing package
- - [ ] login to your `npm` account and create automation token
- - [ ] Create a new repository secrets `NPM_AUTH_TOKEN`
-- [ ] Update description in `packages/r18gs/package.json`
-- [ ] Update Repo Stats by visiting and setting up [repobeats](https://repobeats.axiom.co/)
-- [ ] Create your library and update examples
-- [ ] Update README
-- [ ] Setup GitHub pages to deploy docs
- - [ ] Go to [repo settings](https://github.com/mayank1513/r18gs/settings/pages) -> pages (On left panel); Select deploy from a branch; Then Select `main` and `/docs`
-- [ ] Push your changes/Create PR and see your library being automatically tested and published
-- [ ] Optionally deploy your example(s) to Vercel.
-- [ ] You are most welcome to star this template, contribute, and/or sponsor the `terbo-repo-template` project or my other open-source work
-
-## What's inside?
-
-### Utilities
-
-This Turborepo template includes pre-configured tools:
-
-- [TypeScript](https://www.typescriptlang.org/) for static type checking
-- [ESLint](https://eslint.org/) for code linting
-- [Prettier](https://prettier.io) for code formatting
-- Plop based code generator for scaffolding new components
-- Automatically rebrand this template to match your repo name
-
-### Apps and Packages
-
-This Turborepo includes the following packages/examples/lib:
-
-- `nextjs`: a [Next.js](https://nextjs.org/) app
-- `vite`: a [Vite.js](https://vitest.dev) app
-- `fork-me`: a React component library shared by both `Next.js` and `Vite` examples
-- `eslint-config-custom`: ESLint configurations (includes `eslint-config-next` and `eslint-config-prettier`)
-- `tsconfig`: `tsconfig.json`s used throughout the monorepo
-
-Each package/example is 100% [TypeScript](https://www.typescriptlang.org/).
-
### Build
To build all apps and packages, run the following command:
@@ -105,22 +60,11 @@ cd r18gs
pnpm dev
```
-## Useful Links
-
-Learn more about the power of Turborepo:
-
-- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
-- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
-- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
-- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
-- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
-- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
-
### 🤩 Don't forger to start [this repo](https://github.com/mayank1513/r18gs)!
Want hands-on course for getting started with Turborepo? Check out [React and Next.js with TypeScript](https://mayank-chaudhari.vercel.app/courses/react-and-next-js-with-typescript) and [The Game of Chess with Next.js, React and TypeScrypt](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescrypt/?referralCode=851A28F10B254A8523FE)
-![Repo Stats](https://repobeats.axiom.co/api/embed/2ef1a24385037998386148afe5a98ded6006f410.svg "Repobeats analytics image")
+![Repo Stats](https://repobeats.axiom.co/api/embed/ec3e74d795ed805a0fce67c0b64c3f08872e7945.svg "Repobeats analytics image")
## License
diff --git a/lib/r18gs/CHANGELOG.md b/lib/r18gs/CHANGELOG.md
index f294e17e..e69de29b 100644
--- a/lib/r18gs/CHANGELOG.md
+++ b/lib/r18gs/CHANGELOG.md
@@ -1,31 +0,0 @@
-# @mayank1513/fork-me
-
-## 2.0.1
-
-### Patch Changes
-
-- Add provenance
-
-## 2.0.0
-
-### Major Changes
-
-- Support Next.js 14
-
-## 1.1.2
-
-### Patch Changes
-
-- Add z-index to make sure ribbon is not covered
-
-## 1.1.1
-
-### Patch Changes
-
-- Fix CSS modules
-
-## 1.1.0
-
-### Minor Changes
-
-- Added new prop shadowColor - drop shadow on hover defaults to bgColor
diff --git a/lib/r18gs/README.md b/lib/r18gs/README.md
index 1d007344..d5bcc07d 100644
--- a/lib/r18gs/README.md
+++ b/lib/r18gs/README.md
@@ -1,39 +1,84 @@
-# Fork Me React.js component
+# React18GlobalStore
-A simple fork me component for React.js projects!
+[![test](https://github.com/react18-tools/r18gs/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/r18gs/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/41f10c0e6846d1e8a56b/maintainability)](https://codeclimate.com/github/react18-tools/r18gs/maintainability) [![codecov](https://codecov.io/gh/react18-tools/r18gs/graph/badge.svg)](https://codecov.io/gh/react18-tools/r18gs) [![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/)
+
+## Motivation
+
+I have built wonderful libraries utilizing React18 features using Zustand. They worked awesome. However, when I try importing from specific folder for better tree-shaking, the libraries fail. This is because, for each import a separate zustand store is created. This actually increases the package size also.
+
+Thus, I decided to create a bare minimum, ultra-light store that creates shared state even while importing components from separate files for better treeshaking.
+
+> Will be using this library soon to fix issues with `nextjs-themes`.
+
+## Features
+
+✅ Full TypeScript Support
+
+✅ Unleash the full power of React18 Server components
+
+✅ Works with all build systems/tools/frameworks for React18
+
+✅ Doccumented with [Typedoc](https://react18-tools.github.io/r18gs) ([Docs](https://react18-tools.github.io/r18gs))
+
+✅ Next.js, Vite and Remix examples
## Install
```bash
-$ pnpm add @mayank1513/fork-me
-# or
-$ npm install @mayank1513/fork-me
-# or
-$ yarn add @mayank1513/fork-me
+$ pnpm add r18gs
+```
+
+or
+
+```bash
+$ npm install r18gs
```
-## Add on your page
+or
-```ts
-
with 💖 by Mayank Kumar Chaudhari
diff --git a/lib/r18gs/package.json b/lib/r18gs/package.json index 8295f528..86a9a1b5 100644 --- a/lib/r18gs/package.json +++ b/lib/r18gs/package.json @@ -3,7 +3,7 @@ "author": "Mayank Kumar Chaudhari