Skip to content

Commit ec05250

Browse files
committed
doc
1 parent 83953a6 commit ec05250

File tree

5 files changed

+19
-25
lines changed

5 files changed

+19
-25
lines changed

.github/ISSUE_TEMPLATE/config.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@ contact_links:
44
url: https://github.com/cyrilletuzi/angular-async-local-storage/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/cyrilletuzi/angular-async-local-storage/discussions/categories/ideas
8-
about: Feature requests must be posted and discussed first in the new GitHub "Discussions" tab, in "Ideas" category.
7+
about: Feature requests are no longer accepted.

README.md

+9-14
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,16 @@ 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-
## Sponsorship
11+
## Status of this lib
1212

13-
This library is downloaded more than **15 000 times each week**
14-
[on npm](https://www.npmjs.com/package/@ngx-pwa/local-storage),
15-
and my other major open source project, the [Angular schematics extension for VS Code](https://marketplace.visualstudio.com/items?itemName=cyrilletuzi.angular-schematics),
16-
is **used by 600 000 users**. It represents *months* of full time *unpaid* work.
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.
1714

18-
Want to help me by helping yourself? I released **[Schematics Pro](https://www.schematicspro.dev)**, a code automation tool for Angular, React, Vue, Ionic, Svelte, Stencil, Lit, Nest and more.
15+
## How to help?
16+
17+
My open source work represents *months* of full time *unpaid* work, with for example the [Angular schematics extension for VS Code](https://marketplace.visualstudio.com/items?itemName=cyrilletuzi.angular-schematics),
18+
**used by 600 000 developers**.
19+
20+
So if you want to help, I released **[Schematics Pro](https://www.schematicspro.dev)**, a paid code automation tool for Angular, React, Vue, Ionic, Svelte, Stencil, Lit, Nest and more.
1921

2022
## Why this module?
2123

@@ -44,7 +46,7 @@ to be homogeneous with other Angular modules.
4446
Install the package, according to your Angular version:
4547

4648
```bash
47-
# For Angular LTS (Angular >= 10):
49+
# For Angular LTS (Angular >= 12):
4850
ng add @ngx-pwa/local-storage
4951
```
5052

@@ -217,13 +219,6 @@ For example, it allows to implement a multiple databases scenario.
217219

218220
## Support
219221

220-
### Angular support
221-
222-
We follow [Angular LTS support](https://angular.io/guide/releases).
223-
224-
This module supports [Universal server-side rendering](https://github.com/angular/universal)
225-
via a mock storage.
226-
227222
### Browser support
228223

229224
This lib supports [the same browsers as Angular](https://angular.io/guide/browser-support).

projects/ngx-pwa/local-storage/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@
3030
"tslib": "^2.3.0"
3131
},
3232
"peerDependencies": {
33-
"@angular/common": "^13.0.0",
34-
"@angular/core": "^13.0.0",
35-
"rxjs": "^6.5.3 || ^7.4.0"
33+
"@angular/common": ">=13.0.0",
34+
"@angular/core": ">=13.0.0",
35+
"rxjs": ">=6.5.3"
3636
},
3737
"schematics": "./schematics/collection.json",
3838
"ng-update": {

projects/ngx-pwa/local-storage/schematics/ng-add/index.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ export default function(): Rule {
1010
const angularMajorVersion = getDependencyMajorVersion('@angular/core', host);
1111

1212
if (!angularMajorVersion) {
13-
context.logger.warn(`Not able to detect @angular/core version. Be aware that Angular versions <= 9 are no longer supported.`);
13+
context.logger.warn(`Not able to detect @angular/core version. Be aware that Angular versions <= 10 are no longer supported.`);
1414
}
1515

16-
if (angularMajorVersion && (angularMajorVersion <= 9)) {
17-
throw new SchematicsException('Angular versions <= 9 are no longer supported.');
16+
if (angularMajorVersion && (angularMajorVersion <= 10)) {
17+
throw new SchematicsException('Angular versions <= 10 are no longer supported.');
1818
}
1919

2020
const rxjsMajorVersion = getDependencyMajorVersion('rxjs', host);
2121

2222
if (!rxjsMajorVersion) {
23-
context.logger.warn(`Not able to detect rxjs version. Be aware that rxjs version >= 7.4 is recommended for version 13 of this lib.`);
23+
context.logger.warn(`Not able to detect rxjs version. Be aware that rxjs version >= 7.4 is recommended for Angular >= 13.`);
2424
}
2525

2626
if (angularMajorVersion && rxjsMajorVersion
27-
&& (angularMajorVersion === 13) && (rxjsMajorVersion < 7)) {
27+
&& (angularMajorVersion >= 13) && (rxjsMajorVersion < 7)) {
2828
context.logger.warn(`rxjs should be updated to version >= 7.4. Support for rxjs version 6 is not guaranteed.`);
2929
}
3030

renovate.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
"allowedVersions": "<8"
3232
}
3333
],
34-
"schedule": ["after 1am and before 7am every weekday"],
34+
"schedule": ["after 1am and before 7am on friday"],
3535
"timezone": "Europe/Paris",
3636
"prHourlyLimit": 0,
3737
"dependencyDashboard": false

0 commit comments

Comments
 (0)