@greenblacksky/honmoon 0.4.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +13 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -53,15 +53,19 @@ every running app reloads with the change.
53
53
 
54
54
  The version number still matters. Each app asks for a range
55
55
  (`"@greenblacksky/honmoon": "^0.4.0"`), and the workspace only links this folder
56
- when its version fits. For a change the apps must adapt to, bump it
57
- (`npm version minor`), update the range in each app, and once the repos
58
- are on GitHub tag the commit, so you can always tell which engine an app
59
- was tested with.
60
-
61
- Building an app outside the workspace (for example, automatic
62
- builds on GitHub) needs Honmoon published to a package registry. How to do
63
- that (publicly on npmjs.com, or privately on GitHub Packages), and the GitHub Actions pipeline for
64
- the apps, is in [docs/PUBLISHING.md](docs/PUBLISHING.md).
56
+ when its version fits. For a change the apps must adapt to, bump the minor
57
+ version and update the range in each app.
58
+
59
+ Outside the workspace (for example, an app built on GitHub) the apps
60
+ install the published package from npmjs.com instead. A release takes two
61
+ commands in this folder:
62
+
63
+ ```
64
+ npm version patch 0.4.0 → 0.4.1 (minor for 0.5.0): commits and tags v0.4.1
65
+ git push --follow-tags GitHub sees the tag, checks, tests and publishes
66
+ ```
67
+
68
+ How it was set up is in [docs/PUBLISHING.md](docs/PUBLISHING.md).
65
69
 
66
70
  ## Tests
67
71
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@greenblacksky/honmoon",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "description": "Honmoon: the engine under Mira, Rumi and Zoey — the music model, spaced repetition, audio, notation drawing and the shared Svelte screens.",
5
5
  "license": "MIT",
6
6
  "repository": {