@fairfox/polly 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +9 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @fairfox/web-ext
1
+ # @fairfox/polly
2
2
 
3
3
  **Build Chrome extensions with reactive state and zero boilerplate.**
4
4
 
@@ -36,16 +36,16 @@ This framework fixes all of that:
36
36
 
37
37
  ```bash
38
38
  # Using Bun (recommended)
39
- bun add @fairfox/web-ext
39
+ bun add @fairfox/polly
40
40
 
41
41
  # Using npm
42
- npm install @fairfox/web-ext
42
+ npm install @fairfox/polly
43
43
 
44
44
  # Using pnpm
45
- pnpm add @fairfox/web-ext
45
+ pnpm add @fairfox/polly
46
46
 
47
47
  # Using yarn
48
- yarn add @fairfox/web-ext
48
+ yarn add @fairfox/polly
49
49
  ```
50
50
 
51
51
  ### Create Extension
@@ -54,7 +54,7 @@ yarn add @fairfox/web-ext
54
54
 
55
55
  ```typescript
56
56
  // src/shared/state.ts
57
- import { $sharedState } from '@fairfox/web-ext/state'
57
+ import { $sharedState } from '@fairfox/polly/state'
58
58
 
59
59
  export const counter = $sharedState('counter', 0)
60
60
  export const settings = $sharedState('settings', { theme: 'dark' })
@@ -83,7 +83,7 @@ render(<Popup />, document.getElementById('root')!)
83
83
 
84
84
  ```typescript
85
85
  // src/background/index.ts
86
- import { createBackground } from '@fairfox/web-ext/background'
86
+ import { createBackground } from '@fairfox/polly/background'
87
87
 
88
88
  const bus = createBackground()
89
89
  ```
@@ -95,7 +95,7 @@ const bus = createBackground()
95
95
  **4. Build and load**:
96
96
 
97
97
  ```bash
98
- bunx web-ext build
98
+ polly build
99
99
  ```
100
100
 
101
101
  Load `dist/` folder in Chrome → **Done!** 🎉
@@ -319,4 +319,4 @@ MIT © 2024
319
319
 
320
320
  ---
321
321
 
322
- **[View Examples](./examples/)** · **[Read Docs](./docs/)** · **[Report Issue](https://github.com/fairfox/web-ext/issues)**
322
+ **[View Examples](https://github.com/AlexJeffcott/polly/tree/main/packages/examples)** · **[Read Docs](https://github.com/AlexJeffcott/polly/tree/main/packages/polly/docs)** · **[Report Issue](https://github.com/AlexJeffcott/polly/issues)**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fairfox/polly",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "Multi-execution-context framework with reactive state and cross-context messaging for Chrome extensions, PWAs, and worker-based applications",