Skip to content

Commit e860a1e

Browse files
authored
adjust readme for v2 release (#612)
* adjust readme for v2 release
1 parent 7d57552 commit e860a1e

File tree

5 files changed

+43
-6
lines changed

5 files changed

+43
-6
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# PWA Kit Internal Tools
2+
3+
A package that contains internal tools used by other libraries in the monorepo.
4+
It can't run outside the context of this monorepo.
5+
6+
To see all the available commands:
7+
8+
```bash
9+
cd packages/internal-lib-build
10+
./bin/internal-lib-build --help
11+
```
12+
13+
To see how the package is used inside other packages, see the [pwa-kit-dev](https://github.com/SalesforceCommerceCloud/pwa-kit/blob/develop/packages/pwa-kit-dev/package.json#L29) package configuration.

packages/pwa-kit-dev/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
11
# PWA Kit Developer Tools
2+
3+
A command line interface tool to develop, build, and deploy PWA Kit projects.
4+
5+
## Requirements
6+
7+
```
8+
Node ^14.x
9+
npm ^6.14.4
10+
```
11+
12+
To see all the available commands, run:
13+
14+
```bash
15+
npx pwa-kit-dev --help
16+
```
17+
18+
## Documentation
19+
20+
The full documentation for PWA Kit is hosted on the [Salesforce Developers](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/overview) portal.
21+
22+
### Useful links:
23+
- [Push and deploy bundles](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/pushing-and-deploying-bundles.html)

packages/pwa-kit-runtime/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
# The PWAKit Runtime
1+
# The PWA Kit Runtime
2+
3+
This library contains runtime environments for Node.js applications to run on Managed Runtime.

packages/template-retail-react-app/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ The configuration features include:
4343

4444
### Dedicated Configuration Files
4545

46-
At project generation a single `default` configuration is created. For most cases a single configuration file will get the job done. But there are times where you want to have a different configuration for a different environment. These environments for example could be, a developers local machine, a remote `production` environment, or a remote `staging` environment. In all these cases you want to use a different configuration for each.
46+
At project generation a single `default` configuration is created. For most cases a single configuration file will get the job done. But there are times when you want to have a different configuration for a different environment. These environments for example could be, a developers local machine, a remote `production` environment, or a remote `staging` environment. In all these cases you want to use a different configuration for each.
4747

48-
When multiple configurations are present, which configuration file to used is resolved in the following way:
48+
When multiple configurations are present, here's how the correct configuration file is chosen:
4949

5050
1. Check to see if there is a config file named after your remote Managed Runtime environment and use this if one is present.
5151
2. If we are running on a developer machine, look for a `local` configuration and use this if one is present.
5252
3. Load the `default` config file `config/default.js`.
5353

54-
This allows you do these but not limited to things:
54+
This configuration system allows you to do the following:
5555

5656
- Each developer can have their own configuration, connection to their own Commerce API sandboxes.
5757
- Deploy a single codebase application to multiple environments with their own specific configurations (Multiple B2C Site with Different Domains).
@@ -71,7 +71,7 @@ module.exports = {
7171
}
7272
}
7373
```
74-
You can choose how the current locale appears (or doesnt appear) in the URL by setting `url.locale` to one of the following values:
74+
You can choose how the current locale appears (or doesn't appear) in the URL by setting `url.locale` to one of the following values:
7575

7676
- `path`: Locale is included in the URL path. Example: `/en-US/women/dress`
7777
- `query_param`: Locale is included as a query parameter. Example: `/women/dress?locale=en-US`

packages/template-typescript-minimal/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ built with the pwa-kit SDKs.
99
npm ci
1010
npm start
1111
npm run push
12-
```
12+
```

0 commit comments

Comments
 (0)