Skip to content

Commit 43d294e

Browse files
committed
docs: info about versions
1 parent 2123e40 commit 43d294e

File tree

3 files changed

+12
-23
lines changed

3 files changed

+12
-23
lines changed

README.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ to be homogeneous with other Angular modules.
4545
Install the same version as your Angular one via [npm](http://npmjs.com):
4646

4747
```bash
48-
# For Angular 8:
48+
# For Angular 7 & 8:
4949
npm install @ngx-pwa/local-storage@next
5050

51-
# For Angular 6 and Angular 7:
51+
# For Angular 6:
5252
npm install @ngx-pwa/local-storage@6
5353
```
5454

@@ -67,15 +67,6 @@ export class YourService {
6767

6868
Versions 4 & 5 (only) need an additional setup step explained in [the old module guide](./docs/OLD_MODULE.md).
6969

70-
### About version 7
71-
72-
v7 of this lib works but is not recommended due to unforeseen issues.
73-
For example, v7 doesn't support TypeScript 3.2 due to a TypeScript regression
74-
(see [#64](https://github.com/cyrilletuzi/angular-async-local-storage/issues/64)).
75-
76-
v8 has cleaned the mess, but for users still using Angular 7,
77-
**stay on v6 of this lib as it is compatible with Angular 7 too**.
78-
7970
### Upgrading
8071

8172
If you still use the old `angular-async-local-storage` package, or to update to new versions,
@@ -216,11 +207,8 @@ see the [prefix guide](./docs/COLLISION.md).
216207

217208
## Angular support
218209

219-
This lib major version is aligned to the major version of Angular. Meaning for Angular 6 you need version 6,
220-
for Angular 7 you need version 7, for Angular 8 you need version 8, and so on.
221-
222210
We follow [Angular LTS support](https://angular.io/guide/releases),
223-
meaning we support Angular 6 minimum, until November 2019.
211+
meaning we support Angular >= 6, until November 2019.
224212

225213
This module supports [AoT pre-compiling](https://angular.io/guide/aot-compiler).
226214

docs/MIGRATION_TO_NEW_PACKAGE.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,14 @@ But **do not worry: the previous package is still here** and will be as long as
66
Migration to the new package is recommended as soon as possible to enjoy bug fixes and new features,
77
but is not required for Angular 4 & 5. **It is only required when upgrading to Angular >= 6.**
88

9-
## Version alignment
9+
## Versions
1010

11-
The lib major version is now aligned to the major version of Angular. Meaning you need:
1211
- v4 for Angular 4,
1312
- v5 for Angular 5,
1413
- v6 for Angular 6,
15-
- v7 for Angular 7.
14+
- v8 for Angular 7 & 8.
1615

17-
Note that Angular 4 LTS support has ended.
16+
Note that Angular 4 & 5 LTS support has ended.
1817

1918
## Installing the new package
2019

@@ -35,6 +34,11 @@ npm install @ngx-pwa/local-storage@5
3534
npm install @ngx-pwa/local-storage@6
3635
```
3736

37+
- for **Angular 7 & 8**:
38+
```bash
39+
npm install @ngx-pwa/local-storage@8
40+
```
41+
3842
## Refactoring
3943

4044
Then, **do a global search of `angular-async-local-storage` in your project, and replace with `@ngx-pwa/local-storage`**.

docs/MIGRATION_TO_V7.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@ Unfortunately, unforeseen issues happened, some very bad as they are beyond our
1212

1313
Version 8 achieves the goal we tried in v7 the right way. Everything has been cleaned and things are a lot easier for you.
1414

15-
Then, **we actually recommend to *not* use v7**, to avoid a double painful migration:
16-
- **with Angular 8, upgrade directly to v8 of the lib, and go directly to the [v8 migration guide](./MIGRATION_TO_V8.md),**
17-
- or if you're still using Angular 7, stay on *v6 of the library, which is compatible with Angular 7*.
18-
Bug fixes that happened during v7 have all been backported to v6.
15+
Then, **v7 is deprecated**: for Angular 7 & 8, **upgrade directly to v8 and go to the [v8 migration guide](./MIGRATION_TO_V8.md)**.
1916

2017
## Previous migrations
2118

0 commit comments

Comments
 (0)