Skip to content

Commit 02c8404

Browse files
committed
scope to @gawryco/use-shareable-state and update docs
1 parent a461986 commit 02c8404

2 files changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77

88
Transform your components into shareable, bookmarkable experiences with zero boilerplate.
99

10-
[![npm version](https://img.shields.io/npm/v/use-shareable-state.svg)](https://www.npmjs.com/package/use-shareable-state)
11-
[![Bundle size](https://img.shields.io/bundlephobia/minzip/use-shareable-state.svg)](https://bundlephobia.com/package/use-shareable-state)
10+
[![npm version](https://img.shields.io/npm/v/@gawryco/use-shareable-state.svg)](https://www.npmjs.com/package/@gawryco/use-shareable-state)
11+
[![Bundle size](https://img.shields.io/bundlephobia/minzip/@gawryco/use-shareable-state.svg)](https://bundlephobia.com/package/@gawryco/use-shareable-state)
1212
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
1313
[![CI](https://github.com/gawryco/use-shareable-state/actions/workflows/ci.yml/badge.svg)](https://github.com/gawryco/use-shareable-state/actions/workflows/ci.yml)
1414
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
@@ -113,21 +113,21 @@ Pure URL manipulation. Works with any React app, any router, any bundler.
113113

114114
```bash
115115
# npm
116-
npm install use-shareable-state
116+
npm install @gawryco/use-shareable-state
117117

118118
# pnpm
119-
pnpm add use-shareable-state
119+
pnpm add @gawryco/use-shareable-state
120120

121121
# yarn
122-
yarn add use-shareable-state
122+
yarn add @gawryco/use-shareable-state
123123
```
124124

125125
**Requirements:** React ≥ 17.0.0
126126

127127
## 🚀 Quick Start
128128

129129
```tsx
130-
import { useShareableState } from 'use-shareable-state';
130+
import { useShareableState } from '@gawryco/use-shareable-state';
131131

132132
function SearchPage() {
133133
// Typed string state synced with ?q=...

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "use-shareable-state",
2+
"name": "@gawryco/use-shareable-state",
33
"version": "0.0.1",
44
"description": "The tiny, typed React hook for URL query string state. Transform your components into shareable, bookmarkable experiences with zero boilerplate.",
55
"type": "module",
@@ -43,6 +43,9 @@
4343
"node": ">=18"
4444
},
4545
"packageManager": "pnpm@10.7.0",
46+
"publishConfig": {
47+
"access": "public"
48+
},
4649
"peerDependencies": {
4750
"react": ">=17.0.0"
4851
},

0 commit comments

Comments
 (0)