Skip to content

Commit 3c395b4

Browse files
authored
docs: update the link of repo (#4)
1 parent ec7af51 commit 3c395b4

File tree

8 files changed

+28
-28172
lines changed

8 files changed

+28
-28172
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,12 @@ Given my current professional situation and the lack of support for my open sour
1616
# Checks before posting an issue
1717

1818
- [ ] I have read _all_ the library's documentation:
19-
- [README](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/README.md)
20-
- [CHANGELOG](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/CHANGELOG.md)
21-
- [MIGRATION](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/MIGRATION.md)
22-
- [/docs](https://github.com/santoshyadavdev/ngx-pwa-offline/tree/main/docs)
19+
- [README](https://github.com/ngx-builders/angular-async-local-storage/blob/main/README.md)
20+
- [/docs](https://github.com/ngx-builders/angular-async-local-storage/tree/main/docs)
2321
- [ ] I have checked in already:
24-
- [opened issues](https://github.com/santoshyadavdev/ngx-pwa-offline/issues)
25-
- [closed issues](https://github.com/santoshyadavdev/ngx-pwa-offline/issues?q=is%3Aissue+is%3Aclosed)
26-
- [questions answered](https://github.com/santoshyadavdev/ngx-pwa-offline/discussions/categories/q-a) in the new "Discussions" tab
22+
- [opened issues](https://github.com/ngx-builders/angular-async-local-storage/issues)
23+
- [closed issues](https://github.com/ngx-builders/angular-async-local-storage/issues?q=is%3Aissue+is%3Aclosed)
24+
- [questions answered](https://github.com/ngx-builders/angular-async-local-storage/discussions/categories/q-a) in the new "Discussions" tab
2725
- [ ] I understand I am writing to a *human being*, doing this open source project *unpaid*
2826
- [ ] I will be involved in my own issue, by answering questions and informing if the issue is resolved
2927

.github/ISSUE_TEMPLATE/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ contact_links:
44
url: https://github.com/santoshyadavdev/ngx-pwa-offline/discussions/categories/q-a
55
about: The issue tracker is not intended for support. A new GitHub "Discussions" tab, with a Questions & Answers category, is available for that purpose.
66
- name: Feature requests
7-
url: https://github.com/santoshyadavdev/ngx-pwa-offline/discussions/554
7+
url: https://github.com/santoshyadavdev/ngx-pwa-offline/discussions/categories/ideas
88
about: Feature requests are no longer accepted.

README.md

+10-22
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ Efficient client-side storage module for Angular:
88
- **compatibility**: works around some browsers issues and heavily tested via GitHub Actions,
99
- **documentation**: API fully explained, and a changelog!
1010

11-
## Status of this lib
12-
13-
Given my current professional situation and the lack of support for my open source work, this library is in a frozen state, meaning it is still available on npm but it will no longer get features updates or support.
14-
1511
## Why this module?
1612

1713
For now, Angular does not provide a client-side storage module, and almost every app needs some client-side storage.
@@ -46,18 +42,14 @@ ng add @ngx-builders/pwa-local-storage
4642
*Done!*
4743

4844
You should **stick to these commands**. If for any reason `ng add` does not work,
49-
be sure to follow the [manual installation guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/MANUAL_INSTALLATION.md),
45+
be sure to follow the [manual installation guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/MANUAL_INSTALLATION.md),
5046
as there are additionnal steps to do in addition to the package installation for some versions.
5147

5248
If you have multiple applications in the same project, as usual, you need to choose the project:
5349
```bash
5450
ng add @ngx-builders/pwa-local-storage --project yourprojectname
5551
```
5652

57-
### Upgrading
58-
59-
To update to new versions, see the **[migration guides](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/MIGRATION.md).**
60-
6153
## API
6254

6355
```typescript
@@ -114,7 +106,7 @@ You can store any value, without worrying about serializing. But note that:
114106
- storing `null` or `undefined` makes no sense and can cause issues in some browsers, so the item will be removed instead,
115107
- you should stick to JSON data, ie. primitive types, arrays and *literal* objects.
116108
`Date`, `Map`, `Set`, `Blob` and other special structures can cause issues in some scenarios.
117-
See the [serialization guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/SERIALIZATION.md) for more details.
109+
See the [serialization guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/SERIALIZATION.md) for more details.
118110

119111
### Deleting data
120112

@@ -146,7 +138,7 @@ this.storage.get('notexisting').subscribe((data) => {
146138

147139
**Note you will only get *one* value**: the `Observable` is here for asynchrony but
148140
**is *not* meant to emit again when the stored data is changed**.
149-
If you need to watch the value, see the [watching guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/WATCHING.md).
141+
If you need to watch the value, see the [watching guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/WATCHING.md).
150142

151143
### Checking data
152144

@@ -161,7 +153,7 @@ this.storage.get('test', { type: 'string' }).subscribe({
161153
});
162154
```
163155

164-
**See the [full validation guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/VALIDATION.md) to see how to validate all common scenarios.**
156+
**See the [full validation guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/VALIDATION.md) to see how to validate all common scenarios.**
165157

166158
### Subscription
167159

@@ -190,14 +182,14 @@ this.storage.get('color').pipe(
190182
).subscribe((result) => {});
191183
```
192184

193-
See the [errors guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/ERRORS.md) for some details about what errors can happen.
185+
See the [errors guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/ERRORS.md) for some details about what errors can happen.
194186

195187
### Expiration
196188

197189
This lib, as native `localStorage` and `indexedDb`, is about *persistent* storage.
198190

199191
Wanting *temporary* storage (like `sessionStorage`) is a very common misconception:
200-
an application doesn't need that. [More details here](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/EXPIRATION.md).
192+
an application doesn't need that. [More details here](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/EXPIRATION.md).
201193

202194
### `Map`-like operations
203195

@@ -207,30 +199,26 @@ this lib also provides a `Map`-like API for advanced operations:
207199
- `.has(key)`
208200
- `.size`
209201

210-
See the [documentation](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/MAP_OPERATIONS.md) for more info and some recipes.
202+
See the [documentation](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/MAP_OPERATIONS.md) for more info and some recipes.
211203
For example, it allows to implement a multiple databases scenario.
212204

213205
## Support
214206

215207
### Browser support
216208

217209
This lib supports [the same browsers as Angular](https://angular.io/guide/browser-support).
218-
See [the browsers support guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/BROWSERS_SUPPORT.md) for more details and special cases (like private browsing).
210+
See [the browsers support guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/BROWSERS_SUPPORT.md) for more details and special cases (like private browsing).
219211

220212
### Collision
221213

222214
If you have multiple apps on the same *sub*domain *and* you don't want to share data between them,
223-
see the [prefix guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/COLLISION.md).
215+
see the [prefix guide](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/COLLISION.md).
224216

225217
### Interoperability
226218

227219
For interoperability when mixing this lib with direct usage of native APIs or other libs like `localForage`
228220
(which doesn't make sense in most cases),
229-
see the [interoperability documentation](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/INTEROPERABILITY.md).
230-
231-
### Changelog
232-
233-
[Changelog available here](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/CHANGELOG.md), and [migration guides here](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/MIGRATION.md).
221+
see the [interoperability documentation](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/INTEROPERABILITY.md).
234222

235223
## License
236224

docs/BROWSERS_SUPPORT.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
This lib supports [the same browsers as Angular](https://angular.io/guide/browser-support).
44

55
It also works in tools based on browser engines (like Electron, WebViews, Ionic...),
6-
but not in non-browser tools (like NativeScript, see
7-
[#11](https://github.com/santoshyadavdev/ngx-pwa-offline/issues/11)).
6+
but not in non-browser tools (like NativeScript)
87

98
This module is not impacted by IE missing `indexedDB` features.
109

@@ -14,10 +13,7 @@ Be aware that `indexedDB` usage is limited in browsers when in private / incogni
1413
Most browsers will delete the data when the private browsing session ends.
1514
It's not a real issue as client-side storage is only useful for apps, and apps should not be in private mode.
1615

17-
In some scenarios, `indexedDB` is not available, so the lib fallbacks to (synchronous) `localStorage`. It happens in:
18-
- Firefox private mode (see [#26](https://github.com/santoshyadavdev/ngx-pwa-offline/issues/26))
19-
- Safari, when in a cross-origin iframe (see
20-
[#42](https://github.com/santoshyadavdev/ngx-pwa-offline/issues/42))
16+
In some scenarios, `indexedDB` is not available, so the lib fallbacks to (synchronous) `localStorage`.
2117

2218
If these scenarios are a concern for you, it impacts what you can store.
2319
See the [serialization guide](./SERIALIZATION.md) for full details.

docs/VALIDATION.md

-3
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,6 @@ but not for more complex structures like objects.
149149
Be aware **you are responsible the casted type (`User`) describes the same structure as the JSON schema**.
150150
For the same reason, the lib can't check that.
151151

152-
Auto-inferring the type from all JSON schemas is in progress in
153-
[#463](https://github.com/cyrilletuzi/angular-async-local-storage/issues/463]).
154-
155152
### Validation when writing
156153

157154
While validation is only required when *reading* storage,

0 commit comments

Comments
 (0)