diff --git a/README.md b/docs/README.md similarity index 75% rename from README.md rename to docs/README.md index 27e49f3..aeb5c2e 100644 --- a/README.md +++ b/docs/README.md @@ -1,31 +1,19 @@ -

- - Logo - -❮ ZI ❯ Package - Zsh-bin -

- -

- +
+
+ Logo + +

❮ ZI ❯ Package - Statically-linked, hermetic, relocatable Zsh

+

+ | **Package source:** | Source Tarball | Binary | Git | Node | Gem | | :-----------------: | :------------: | :----: | :--------------------------: | :--: | :-: | | **Status:** | :x: | :x: | :heavy_check_mark: (default) | :x: | :x: |

- -> This repository compatible with [ZI](https://github.com/z-shell-zi) - -[ZI](https://github.com/z-shell/zi) can use a `package.json` -(similar in construct to the one used in `npm` packages) to automatically: - -- get the plugin's Git repository OR release-package URL, -- get the list of the recommended ices for the plugin, - - there can be multiple lists of ices, - - the ice lists are stored in _profiles_; there's at least one profile, _default_, - - the ices can be selectively overridden. - + Logo +
+ The package provides the [romkatv/zsh-bin](https://github.com/romkatv/zsh-bin) statically-linked, hermetic, relocatable Zsh -## Install ### Available `pack''` invocations @@ -52,5 +40,18 @@ Does not require **root**, will install to ~/.local. zi lucid as"null" depth"1" \ atclone"./install -e no -d ~/.local" \ atpull"%atclone" nocompile nocompletions \ - for @romkatv/zsh-bin + for @romkatv/zsh-bin ``` + +--- + +> This repository compatible with [ZI](https://github.com/z-shell-zi) + +[ZI](https://github.com/z-shell/zi) can use a `package.json` +(similar in construct to the one used in `npm` packages) to automatically: + +- get the plugin's Git repository OR release-package URL, +- get the list of the recommended ices for the plugin, + - there can be multiple lists of ices, + - the ice lists are stored in _profiles_; there's at least one profile, _default_, + - the ices can be selectively overridden.