Skip to content

Commit 86861ac

Browse files
authored
Update README.md
Migrating documentation Signed-off-by: webKrafter <54419534+webKrafter@users.noreply.github.com>
1 parent be7cb32 commit 86861ac

1 file changed

Lines changed: 23 additions & 23 deletions

File tree

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@
55
<a href="https://typescriptlang.org">
66
<img alt="TypeScript" src="https://badgen.net/badge/icon/typescript?icon=typescript&label">
77
</a>
8-
<a href="https://github.com/webKrafters/react-observable-context/actions">
9-
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/webKrafters/react-observable-context/test.yml">
8+
<a href="https://github.com/webKrafters/react-observable-context.js/actions">
9+
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/webKrafters/react-observable-context.js/test.yml">
1010
</a>
11-
<a href="https://coveralls.io/github/webKrafters/react-observable-context">
12-
<img alt="coverage" src="https://img.shields.io/coverallsCoverage/github/webKrafters/react-observable-context.svg">
11+
<a href="https://coveralls.io/github/webKrafters/react-observable-context.js">
12+
<img alt="coverage" src="https://img.shields.io/coverallsCoverage/github/webKrafters/react-observable-context.js.svg">
1313
</a>
14-
<img alt="NPM" src="https://img.shields.io/npm/l/@webkrafters/react-observable-context">
14+
<img alt="NPM" src="https://img.shields.io/npm/l/@webkrafters/react-observable-context.js">
1515
<img alt="Maintenance" src="https://img.shields.io/maintenance/yes/2032">
16-
<img alt="build size" src="https://img.shields.io/bundlephobia/minzip/@webkrafters/react-observable-context?label=bundle%20size">
17-
<a href="https://www.npmjs.com/package/@webKrafters/react-observable-context">
18-
<img alt="Downloads" src="https://img.shields.io/npm/dt/@webkrafters/react-observable-context.svg">
16+
<img alt="build size" src="https://img.shields.io/bundlephobia/minzip/@webkrafters/react-observable-context.js?label=bundle%20size">
17+
<a href="https://www.npmjs.com/package/@webKrafters/react-observable-context.js">
18+
<img alt="Downloads" src="https://img.shields.io/npm/dt/@webkrafters/react-observable-context.js.svg">
1919
</a>
20-
<img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/webKrafters/react-observable-context">
20+
<img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/webKrafters/react-observable-context.js">
2121
</p>
2222

2323
# React-Observable-Context [Eagle Eye]
@@ -32,18 +32,18 @@
3232

3333
<ul>
3434
<li> Ready for use anywhere in the app. No Provider components needed.</li>
35-
<li> Auto-immutable update-friendly context. See <a href="https://eagleeye.js.org/concepts/store/setstate"><code>store.setState</code> (docs under revision)</a>.</li>
36-
<li> A context bearing an observable consumer <a href="https://eagleeye.js.org/concepts/store">store (docs under revision)</a>.</li>
37-
<li> Recognizes <b>negative array indexing</b>. Please see <a href="https://eagleeye.js.org/concepts/property-path">Property Path (docs under revision)</a> and <code>store.setState</code> <a href="https://eagleeye.js.org/concepts/store/setstate#indexing">Indexing (docs under revision)</a>.</li>
38-
<li> Only re-renders subscribing components (<a href="https://eagleeye.js.org/concepts/client">clients (docs under revision)</a>) on context state changes.</li>
35+
<li> Auto-immutable update-friendly context. See <a href="https://react-observable-context.js.org/concepts/store/setstate"><code>store.setState</code> (docs under revision)</a>.</li>
36+
<li> A context bearing an observable consumer <a href="https://react-observable-context.js.org/concepts/store">store (docs under revision)</a>.</li>
37+
<li> Recognizes <b>negative array indexing</b>. Please see <a href="https://react-observable-context.js.org/concepts/property-path">Property Path (docs under revision)</a> and <code>store.setState</code> <a href="https://react-observable-context.js.org/concepts/store/setstate#indexing">Indexing (docs under revision)</a>.</li>
38+
<li> Only re-renders subscribing components (<a href="https://react-observable-context.js.org/concepts/client">clients (docs under revision)</a>) on context state changes.</li>
3939
<li> Subscribing component decides which context state properties' changes to trigger its update.</li>
4040
</ul>
4141

4242
**Name:** React-Observable-Context
4343

4444
**Moniker:** Legacy Eagle Eye
4545

46-
**Usage:** Please see <b><a href="https://eagleeye.js.org/getting-started">Getting Started (docs under revision)</a></b>.
46+
**Usage:** Please see <b><a href="https://react-observable-context.js.org/getting-started">Getting Started (docs under revision)</a></b>.
4747

4848
**Demo:** [Play with the app on codesandbox](https://codesandbox.io/s/github/webKrafters/react-observable-context-app)\
4949
If sandbox fails to load app, please refresh dependencies on its lower left.
@@ -103,13 +103,13 @@ Deactivates this context by:
103103
### Accessing external store reference.
104104
```tsx
105105
const store = context.store;
106-
// https://eagleeye.js.org/concepts/store/resetstate/
106+
// https://react-observable-context.js.org/concepts/store/resetstate/
107107
store.resetState( Array<string>? );
108-
// https://eagleeye.js.org/concepts/store/setstate/
108+
// https://react-observable-context.js.org/concepts/store/setstate/
109109
store.setState( Changes<T> );
110-
// https://eagleeye.js.org/concepts/store/getstate/
110+
// https://react-observable-context.js.org/concepts/store/getstate/
111111
const state = store.getState( Array<string> );
112-
// https://eagleeye.js.org/concepts/store/subscribe/
112+
// https://react-observable-context.js.org/concepts/store/subscribe/
113113
const unsubscribeFn = store.subscribe( eventType, listener );
114114
```
115115
Any actions taken here is applied to all components streaming affected state slices.\
@@ -121,14 +121,14 @@ A context stream allows a client to set up a dedicated channel through which it
121121
```tsx
122122
const useStream = context.stream;
123123
// joining the stream twice
124-
// for more on selectorMap - https://eagleeye.js.org/concepts/selector-map/
124+
// for more on selectorMap - https://react-observable-context.js.org/concepts/selector-map/
125125
const store1 = useStream(SelectorMap?);
126126
const store2 = useStream(SelectorMap?);
127127
// access the current data value monitored by this store
128128
console.log( 'data', store1.data );
129-
// https://eagleeye.js.org/concepts/store/resetstate/
129+
// https://react-observable-context.js.org/concepts/store/resetstate/
130130
store1.resetState( Array<string>? ); // changes are context-wide
131-
// https://eagleeye.js.org/concepts/store/setstate/
131+
// https://react-observable-context.js.org/concepts/store/setstate/
132132
store1.setState( Changes<T> ); // changes are context-wide
133133
```
134134
Any actions taken here is applied to all components streaming affected state slices.\
@@ -165,10 +165,10 @@ const storage = context.storage;
165165
context.storage = IStorage<T>?;
166166
```
167167
168-
May also see <b><a href="https://eagleeye.js.org/history/features">What's Changed? (docs currently under revision)</a></b>
168+
May also see <b><a href="https://react-observable-context.js.org/history/features">What's Changed? (docs currently under revision)</a></b>
169169
170170
## Please see full documentation here:
171-
**[eagleeye.js.org](https://eagleeye.js.org)** (currently out-of-date pending revision)
171+
**[eagleeye.js.org](https://react-observable-context.js.org)** (currently out-of-date pending revision)
172172
173173
# License
174174

0 commit comments

Comments
 (0)