Skip to content

Commit 53e6826

Browse files
committed
Grammer
Signed-off-by: cobalt <61329810+cobaltt7@users.noreply.github.com>
1 parent 5e618f0 commit 53e6826

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @sa-community/addons-data
22

3-
This repository contains [the script](.github/workflows/update.yml) that generates [@sa-community/addons-data](https://npmjs.com/package/@sa-community/addons-data).
3+
This repository contains [the script](.github/workflows/update.yml) used to auto-generate [@sa-community/addons-data](https://npmjs.com/package/@sa-community/addons-data).
44

55
## Usage
66

@@ -12,7 +12,8 @@ const addons = require("@sa-community/addons-data");
1212
addons.filter((addon) => addon.manifest.tags.includes("forums")).map((addon) => addon.manifest);
1313
```
1414

15-
Addon IDs are not in the manifest, so if you wanted to get all of their IDs:
15+
Addon IDs are not included in the manifest itself.
16+
To get them:
1617

1718
```js
1819
const addons = require("@sa-community/addons-data");
@@ -21,7 +22,7 @@ addons.filter((addon) => addon.manifest.tags.includes("forums")).map((addon) =>
2122

2223
### Types
2324

24-
The package, including addon manifests, is fully typed.
25+
The package is fully typed, including all addon manifests.
2526
The [addon manifest typedef](types.d.ts) is based off [manifest-schema](https://github.com/ScratchAddons/manifest-schema), and I try to keep them as similar as possible.
2627

2728
All [addon manifests on Scratch Addons's `master` branch](https://github.com/ScratchAddons/ScratchAddons/tree/master/addons) are typechecked against that typedef every 12 hours.
@@ -40,8 +41,8 @@ Everything the typedef checks is also checked by the JSON Schema, but there are
4041
- No extraneous properties
4142
- Every addon having one of the "main" tags (community, editor, player, popup)
4243

43-
The main advantage of using the typedef over the schema for manifest verification is ease of maintainability.
44-
TypeScript typedefs are also more portable and can be used in more contexts than a JSON schema could be.
44+
Ease of maintenance is the typedef's main advantage over the schema for manifest verification.
45+
TypeScript typedefs are also more portable and could be used in more contexts than a JSON schema could be.
4546

4647
### Importing a single addon's data
4748

@@ -53,7 +54,7 @@ console.log(addon.name); // Semicolon glitch
5354
console.log(addon.credits[0].name); // GrahamSH
5455
```
5556

56-
Note that while the package is typed, each addon is typed generically to avoid breaking changes.
57+
Note that while the package is typed, each addon is typed generically to prevent breaking changes.
5758
Meaning, the type of each addon is the generic `AddonManifest`, and the types do not define specific keys for specific addons.
5859

5960
### Importing the manifest

0 commit comments

Comments
 (0)