Documented self update feature

RhetTbull · Feb 17, 2024 · 17279fc · 17279fc
1 parent 5427597
commit 17279fc
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 12 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.10
+current_version = 0.2.0
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)
 serialize = {major}.{minor}.{patch}
 

diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ See the [latest release](https://github.com/RhetTbull/applecrate/releases/latest
 
 Note: I've not yet figured out how to create a universal binary with PyApp so you'll need to download the correct installer package for your platform, e.g. `applecrate-0.1.7-x86_64-installer.pkg` for Intel Macs and `applecrate-0.1.7-arm64-installer.pkg` for Apple Silicon Macs.
 
-The installer package will add the `applecrate` command line tool to `/usr/local/bin`. You can upgrade to a new version of AppleCrate by running `applecrate self update` (this only works if you installed AppleCrate with the installer package).
+The installer package will add the `applecrate` command line tool to `/usr/local/bin`. You can upgrade to a new version of AppleCrate by running `applecrate update`.
 
 Alternatively, you can install AppleCrate with `pip` or `pipx`:
 
@@ -26,6 +26,16 @@ or
 pipx install applecrate
 ```
 
+## Upgrading
+
+AppleCrate includes a self-update command to upgrade your installation to the latest version of AppleCrate. This works for both the binary installer package and the `pip` or `pipx` installation.
+
+```bash
+applecrate update
+```
+
+If you are interested in implementing this in your own Python package, see the [implementation](https://github.com/RhetTbull/applecrate/blob/main/applecrate/selfupdate.py).
+
 ## Simple Example
 
 ```bash
@@ -116,13 +126,13 @@ Options:
                                   install the file 'dist/app' to
                                   '/usr/local/bin/app-1.0.0' if --app=app and
                                   --version=1.0.0.
-  -k, --link SRC TARGET           Create a symbolic link from SRC to DEST after
-                                  installation. SRC and TARGET must be absolute
-                                  paths and both may include template variables
-                                  {{ app }} and {{ version }}. For example:
-                                  `--link "/Library/Application Support/{{ app
-                                  }}/{{ version }}/app" "/usr/local/bin/{{ app
-                                  }}-{{ version }}"`
+  -k, --link SRC TARGET           Create a symbolic link from SRC to TARGET
+                                  after installation. SRC and TARGET must be
+                                  absolute paths and both may include template
+                                  variables {{ app }} and {{ version }}. For
+                                  example: `--link "/Library/Application
+                                  Support/{{ app }}/{{ version }}/app"
+                                  "/usr/local/bin/{{ app }}-{{ version }}"`
   -p, --pre-install FILE          Path to pre-install shell script; if not
                                   provided, a pre-install script will be created
                                   for you.

diff --git a/applecrate.toml b/applecrate.toml
@@ -2,12 +2,12 @@
 # The version in this file will be updated by bump2version
 
 app = "applecrate"
-version = "0.1.10"
+version = "0.2.0"
 identifier = "org.rhettbull.applecrate"
 license = "LICENSE"
 install = [
     [
-        "build/applecrate-0.1.10-{{ machine }}",
+        "build/applecrate-0.2.0-{{ machine }}",
         "/usr/local/bin/applecrate",
     ],
 ]

diff --git a/applecrate/version.py b/applecrate/version.py
@@ -1 +1 @@
-__version__ = "0.1.10"
+__version__ = "0.2.0"