Skip to content

Commit 3b5083b

Browse files
HamdaanAliQuatilalan-agius4
authored andcommitted
docs: update @angular/pwa readme
(cherry picked from commit 05b9ce5)
1 parent 7d0cebd commit 3b5083b

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

packages/angular/pwa/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
# `@angular/pwa`
22

33
This is a [schematic](https://angular.io/guide/schematics) for adding
4-
[Progress Web App](https://web.dev/progressive-web-apps/) support to an Angular app. Run the
4+
[Progressive Web App](https://web.dev/progressive-web-apps/) support to an Angular project. Run the
55
schematic with the [Angular CLI](https://angular.io/cli):
66

77
```shell
8-
ng add @angular/pwa
8+
ng add @angular/pwa --project <project-name>
99
```
1010

11-
This makes a few changes to your project:
11+
Executing the command mentioned above will perform the following actions:
1212

13-
1. Adds [`@angular/service-worker`](https://npmjs.com/@angular/service-worker) as a dependency.
13+
1. Adds [`@angular/service-worker`](https://npmjs.com/@angular/service-worker) as a dependency to your project.
1414
1. Enables service worker builds in the Angular CLI.
15-
1. Imports and registers the service worker in the app module.
16-
1. Adds a [web app manifest](https://developer.mozilla.org/en-US/docs/Web/Manifest).
17-
1. Updates the `index.html` file to link to the manifest and set theme colors.
18-
1. Adds required icons for the manifest.
19-
1. Creates a config file `ngsw-config.json`, specifying caching behaviors and other settings.
15+
1. Imports and registers the service worker in the application module.
16+
1. Updates the `index.html` file:
17+
- Includes a link to add the [manifest.webmanifest](https://developer.mozilla.org/en-US/docs/Web/Manifest) file.
18+
- Adds a meta tag for `theme-color`.
19+
1. Installs icon files to support the installed Progressive Web App (PWA).
20+
1. Creates the service worker configuration file called `ngsw-config.json`, specifying caching behaviors and other settings.
2021

2122
See [Getting started with service workers](https://angular.io/guide/service-worker-getting-started)
2223
for more information.

0 commit comments

Comments
 (0)