Skip to content

Commit

Permalink
docs: update the link of repo (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
Omkar0114 authored Jul 10, 2022
1 parent ec7af51 commit 3c395b4
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 28,172 deletions.
12 changes: 5 additions & 7 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,12 @@ Given my current professional situation and the lack of support for my open sour
# Checks before posting an issue

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

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ contact_links:
url: https://github.com/santoshyadavdev/ngx-pwa-offline/discussions/categories/q-a
about: The issue tracker is not intended for support. A new GitHub "Discussions" tab, with a Questions & Answers category, is available for that purpose.
- name: Feature requests
url: https://github.com/santoshyadavdev/ngx-pwa-offline/discussions/554
url: https://github.com/santoshyadavdev/ngx-pwa-offline/discussions/categories/ideas
about: Feature requests are no longer accepted.
32 changes: 10 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ Efficient client-side storage module for Angular:
- **compatibility**: works around some browsers issues and heavily tested via GitHub Actions,
- **documentation**: API fully explained, and a changelog!

## Status of this lib

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.

## Why this module?

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

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

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

### Upgrading

To update to new versions, see the **[migration guides](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/MIGRATION.md).**

## API

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

### Deleting data

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

**Note you will only get *one* value**: the `Observable` is here for asynchrony but
**is *not* meant to emit again when the stored data is changed**.
If you need to watch the value, see the [watching guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/WATCHING.md).
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).

### Checking data

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

**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.**
**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.**

### Subscription

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

See the [errors guide](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/ERRORS.md) for some details about what errors can happen.
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.

### Expiration

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

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

### `Map`-like operations

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

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

## Support

### Browser support

This lib supports [the same browsers as Angular](https://angular.io/guide/browser-support).
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).
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).

### Collision

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

### Interoperability

For interoperability when mixing this lib with direct usage of native APIs or other libs like `localForage`
(which doesn't make sense in most cases),
see the [interoperability documentation](https://github.com/santoshyadavdev/ngx-pwa-offline/blob/main/docs/INTEROPERABILITY.md).

### Changelog

[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).
see the [interoperability documentation](https://github.com/ngx-builders/angular-async-local-storage/blob/main/docs/INTEROPERABILITY.md).

## License

Expand Down
8 changes: 2 additions & 6 deletions docs/BROWSERS_SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
This lib supports [the same browsers as Angular](https://angular.io/guide/browser-support).

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

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

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

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

If these scenarios are a concern for you, it impacts what you can store.
See the [serialization guide](./SERIALIZATION.md) for full details.
Expand Down
3 changes: 0 additions & 3 deletions docs/VALIDATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,6 @@ but not for more complex structures like objects.
Be aware **you are responsible the casted type (`User`) describes the same structure as the JSON schema**.
For the same reason, the lib can't check that.

Auto-inferring the type from all JSON schemas is in progress in
[#463](https://github.com/cyrilletuzi/angular-async-local-storage/issues/463]).

### Validation when writing

While validation is only required when *reading* storage,
Expand Down
Loading

0 comments on commit 3c395b4

Please sign in to comment.