diff --git a/CHANGELOG.md b/CHANGELOG.md index 955935e..3fcec7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 _No unreleased changes._ -## [1.5.0] - 2021-08-09 +## [1.5.0] - 2021-08-10 ### Added - Option to use the new `degit` tool in `zmodule`, that is able to install and update modules diff --git a/README.md b/README.md index 9a07b14..567f59f 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,11 @@ Zim has many [modules available][modules]. Enable as many or as few as you'd lik To preview some of the available themes, check the [themes page][themes]. +### Degit + +Install modules without requiring `git` using our degit tool. It's faster and +lighter. See the [zmodule](#zmodule) usage below. + Installation ------------ Installing Zim is easy: @@ -75,36 +80,45 @@ Usage ### zmodule -
-Usage: zmodule <url> [-n|--name <module_name>] [options]
+
Usage: zmodule <url> [-n|--name <module_name>] [options]
 
-Add zmodule calls to your ~/.zimrc file to define the modules to be initialized. The modules are
+Add zmodule calls to your ~/.zimrc file to define the modules to be initialized. The modules are
 initialized in the same order they are defined.
 
   <url>                      Module absolute path or repository URL. The following URL formats
-                             are equivalent: name, zimfw/name, https://github.com/zimfw/name.git.
-  -n|--name <module_name>    Set a custom module name. Default: the last component in the <url>.
+                             are equivalent: name, zimfw/name, https://github.com/zimfw/name.git.
+  -n|--name <module_name>    Set a custom module name. Default: the last component in the <url>.
+                             Use slashes inside the name to organize the module into subdirecto-
+                             ries.
 
 Repository options:
-  -b|--branch <branch_name>  Use specified branch when installing and updating the module.
-                             Overrides the tag option. Default: the repository's default branch.
-  -t|--tag <tag_name>        Use specified tag when installing and updating the module.
+  -b|--branch <branch_name>  Use specified branch when installing and updating the module.
+                             Overrides the tag option. Default: the repository's default branch.
+  -t|--tag <tag_name>        Use specified tag when installing and updating the module.
                              Overrides the branch option.
-  -z|--frozen                Don't install or update the module.
+  -u|--use <git|degit>       Install and update the module using the defined tool. Default is
+                             defined by zstyle ':zim:zmodule' use '<git|degit>', or git if none
+                             is provided.
+                             git requires git to be installed. Local changes are preserved during
+                             updates.
+                             degit requires curl or wget, and currently only works with GitHub
+                             URLs. Modules install faster and take less disk space. Local changes
+                             are lost during updates. Git submodules are not supported.
+  -z|--frozen                Don't install or update the module.
 
 Initialization options:
-  -f|--fpath <path>          Add specified path to fpath. The path is relative to the module
-                             root directory. Default: functions, if the subdirectory exists.
-  -a|--autoload <func_name>  Autoload specified function. Default: all valid names inside the
-                             module's specified fpath paths.
-  -s|--source <file_path>    Source specified file. The file path is relative to the module root
-                             directory. Default: init.zsh, if the functions subdirectory also
+  -f|--fpath <path>          Add specified path to fpath. The path is relative to the module
+                             root directory. Default: functions, if the subdirectory exists.
+  -a|--autoload <func_name>  Autoload specified function. Default: all valid names inside the
+                             module's specified fpath paths.
+  -s|--source <file_path>    Source specified file. The file path is relative to the module root
+                             directory. Default: init.zsh, if the functions subdirectory also
                              exists, or the file with largest size matching
-                             {init.zsh,module_name.{zsh,plugin.zsh,zsh-theme,sh}}, if any exist.
-  -c|--cmd <command>         Execute specified command. Occurrences of the {} placeholder in the
+                             {init.zsh,module_name.{zsh,plugin.zsh,zsh-theme,sh}}, if any exist.
+  -c|--cmd <command>         Execute specified command. Occurrences of the {} placeholder in the
                              command are substituted by the module root directory path.
-                             -s 'script.zsh' and -c 'source {}/script.zsh' are equivalent.
-  -d|--disabled              Don't initialize or uninstall the module.
+                             I.e., -s 'script.zsh' and -c 'source {}/script.zsh' are equivalent.
+  -d|--disabled              Don't initialize or uninstall the module.
 

 
 ### zimfw
@@ -122,6 +136,12 @@ For more information about the `zimfw` tool, run `zimfw help`.
 Settings
 --------
 
+Modules are installed using `git` by default. If you don't have `git`
+installed, or if you want to take advantage of our degit tool for faster and
+lighter module installations, you can set degit as the default tool with:
+
+    zstyle ':zim:zmodule' use 'degit'
+
 By default, `zimfw` will check if it has a new version available every 30 days.
 This can be disabled with: