Skip to content

Commit 70e05dd

Browse files
authored
docs: fix typos and polish README wording (apple#1499)
Fixed minor typos and improved wording in the README for clarity and consistency.
1 parent e3c4980 commit 70e05dd

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
The tool consumes and produces [OCI-compatible container images](https://github.com/opencontainers/image-spec), so you can pull and run images from any standard container registry. You can push images that you build to those registries as well, and run the images in any other OCI-compatible application.
99

10-
`container` uses the [Containerization](https://github.com/apple/containerization) Swift package for low level container, image, and process management.
10+
`container` uses the [Containerization](https://github.com/apple/containerization) Swift package for low-level container, image, and process management.
1111

1212
![introductory movie showing some basic commands](./docs/assets/landing-movie.gif)
1313

@@ -17,7 +17,7 @@ The tool consumes and produces [OCI-compatible container images](https://github.
1717

1818
You need a Mac with Apple silicon to run `container`. To build it, see the [BUILDING](./BUILDING.md) document.
1919

20-
`container` is supported on macOS 26, since it takes advantage of new features and enhancements to virtualization and networking in this release. We do not support older versions of macOS and the `container` maintainers typically will not address issues that cannot be reproduced on the macOS 26.
20+
`container` is supported on macOS 26, since it takes advantage of new features and enhancements to virtualization and networking in this release. We do not support older versions of macOS and the `container` maintainers typically will not address issues that cannot be reproduced on macOS 26.
2121

2222
### Initial install
2323

@@ -35,19 +35,19 @@ container system start
3535

3636
For both upgrading and downgrading, you can manually download and install the signed installer package by following the steps from [initial install](#initial-install) or use the `update-container.sh` script (installed to `/usr/local/bin`).
3737

38-
If you're upgrading and downgrading, you must stop your existing `container`:
38+
If you're upgrading or downgrading, you must stop your existing `container`:
3939

4040
```bash
4141
container system stop
4242
```
4343

44-
For upgrading to the latest release version, simply run the command below:
44+
To upgrade to the latest release, simply run the command below:
4545

4646
```bash
4747
/usr/local/bin/update-container.sh
4848
```
4949

50-
If you're downgrading, you must uninstall your existing `container` (the `-k` flag keeps your user data, while `-d` removes it):
50+
To downgrade, you must uninstall your existing `container` (the `-k` flag keeps your user data, while `-d` removes it):
5151

5252
```bash
5353
/usr/local/bin/uninstall-container.sh -k
@@ -85,8 +85,8 @@ To retain your user data so that it is available should you reinstall later, run
8585

8686
## Contributing
8787

88-
Contributions to `container` are welcomed and encouraged. Please see our [main contributing guide](https://github.com/apple/containerization/blob/main/CONTRIBUTING.md) for more information.
88+
Contributions to `container` are welcome and encouraged. Please see our [main contributing guide](https://github.com/apple/containerization/blob/main/CONTRIBUTING.md) for more information.
8989

9090
## Project Status
9191

92-
The container project is currently under active development. Its stability, both for consuming the project as a Swift package and the `container` tool, is only guaranteed within patch versions, such as between 0.1.1 and 0.1.2. Minor version number releases may include breaking changes until we achieve a 1.0.0 release.
92+
The container project is currently under active development. Its stability, both for consuming the project as a Swift package and the `container` tool, is only guaranteed within patch versions, such as between 0.1.1 and 0.1.2. Minor version releases may include breaking changes until we reach a 1.0.0 release.

0 commit comments

Comments
 (0)