@bscotch/yy 2.4.0 → 2.6.0

package/README.md

@@ -35,7 +35,7 @@ In your project root:
 
 ### Programmatic
 
-In your Node code:
+Main entrypoint for reading and writing Yy files:
 
 ```ts
 // In Typescript, or in an ES6 module:
@@ -48,9 +48,46 @@ parsedFile = await Yy.read('./my-project.yyp');
 const reStringified = Yy.stringify(parsedFile);
 ```
 
+Update the version of a GameMaker project by setting the per-target version fields in all options files:
+
+```ts
+import { setProjectVersion } from '@bscotch/yy';
+await setProjectVersion('my/project.yyp', '1.2.3.4');
+```
+
+Ensure a script exists, for example to update a script containing version information as part of a build pipeline (note that the [`@bscotch/gml-parser](https://www.npmjs.com/package/@bscotch/gml-parser) project is more full-featured for managing assets):
+
+```ts
+import { addScript } from '@bscotch/yy';
+await addScript('my/project.yyp', 'versioning', 'global.VERSION = 1.2.3.4');
+```
+
+Ensure a collection of audio or texture groups exist, for example as part of an automatic group-assignment pipeline:
+
+```ts
+import { ensureGroups } from '@bscotch/yy';
+await ensureGroups('my/project.yyp', 'audio', [
+  'MyAudioGroup',
+  'MyOtherAudioGroup',
+]);
+await ensureGroups('my/project.yyp', 'texture', [
+  'MyTextureGroup',
+  'MyOtherTextureGroup',
+]);
+```
+
 ### CLI
 
-Currently this package provides one CLI command, which generates a diff between two `.yy`/`.yyp`-like files:
+This package provides a few CLI commands, available with the command `yy` if globally installed (e.g. by `npm i -g @bscotch/yy`) or by `npx yy` for a local install.
+
+### `yy diff`
+
+Get a diff between two `.yy`/`.yyp`-like files:
+
+`yy diff file1.yy file2.yy`
+
+### `yy version`
+
+Set the projects version via all of its Options files, so that all platforms will be synced to a particular version:
 
-- If globally installed: `yy diff file1.yy file2.yy`
-- If locally installed: `npx yy diff file1.yy file2.yy` (or similar, depending on your Node package manager)
+`yy version path/to/project.yyp 1.2.3.4`