Skip to content

Commit 101050f

Browse files
committed
doc
1 parent 1126a2f commit 101050f

File tree

6 files changed

+40
-4
lines changed

6 files changed

+40
-4
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
This library is fully documented and so you will find detailed [migration guides](https://github.com/cyrilletuzi/angular-async-local-storage/blob/main/MIGRATION.md).
44

5+
## 20.0.0 (2025-05-29)
6+
7+
### Breaking changes
8+
9+
- Angular 20 is required.
10+
511
## 19.0.0 (2024-11-19)
612

713
### Breaking changes

MIGRATION.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- [Migration to version 17](./docs/MIGRATION_TO_V17.md)
1414
- [Migration to version 18](./docs/MIGRATION_TO_V18.md)
1515
- [Migration to version 19](./docs/MIGRATION_TO_V19.md)
16+
- [Migration to version 19](./docs/MIGRATION_TO_V20.md)
1617

1718
[Full changelog available here.](./CHANGELOG.md)
1819

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This library has a simple API similar to native `localStorage`, but internally s
2828
Install the package:
2929

3030
```bash
31-
# For Angular LTS (Angular >= 17):
31+
# For Angular LTS (Angular >= 18):
3232
ng add @ngx-pwa/local-storage
3333
```
3434

@@ -37,7 +37,7 @@ ng add @ngx-pwa/local-storage
3737
If for any reason `ng add` does not work, follow the [manual installation guide](https://github.com/cyrilletuzi/angular-async-local-storage/blob/main/docs/MANUAL_INSTALLATION.md).
3838

3939
> [!NOTE]
40-
> Angular versions <= 15 are [officially outdated](https://angular.dev/reference/versions).
40+
> Angular versions <= 17 are [officially outdated](https://angular.dev/reference/versions).
4141
4242
### Upgrading
4343

docs/MIGRATION_TO_NEW_PACKAGE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ But **do not worry: the previous package is still here** and will be as long as
1414
- v16 for Angular 16,
1515
- v17 for Angular 17,
1616
- v18 for Angular 18,
17-
- v19 for Angular 19.
17+
- v19 for Angular 19,
18+
- v20 for Angular 20.
1819

19-
[Angular <= 15 are officially outdated](https://angular.dev/reference/versions#actively-supported-versions).
20+
[Angular <= 17 are officially outdated](https://angular.dev/reference/versions#actively-supported-versions).
2021

2122
## Installing the new package
2223

docs/MIGRATION_TO_V19.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ ng update @ngx-pwa/local-storage
1717
> [!IMPORTANT]
1818
> RxJS 6 is *not* supported.
1919
20+
Done, no code changes.
21+
2022
## More documentation
2123

2224
- [Full changelog for v19](../CHANGELOG.md)

docs/MIGRATION_TO_V20.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Migration guide to version 20
2+
3+
## How to update
4+
5+
```bash
6+
ng update @ngx-pwa/local-storage
7+
```
8+
9+
> [!IMPORTANT]
10+
> If your project is actually in a version < 19, please do the [other migrations](../MIGRATION.md) first in an incremental way. **The version 9 migration is especially important**, as a wrongly done migration could lead to the loss of all previously stored data.
11+
12+
## Breaking changes
13+
14+
- Angular 20 is required.
15+
- RxJS >= 7.6 is required.
16+
17+
> [!IMPORTANT]
18+
> RxJS 6 is *not* supported.
19+
20+
Done, no code changes.
21+
22+
## More documentation
23+
24+
- [Full changelog for v20](../CHANGELOG.md)
25+
- [Other migration guides](../MIGRATION.md)
26+
- [Main documentation](../README.md)

0 commit comments

Comments
 (0)