Skip to content

Commit

Permalink
Update and rename README.md to docs/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ss-o authored Mar 31, 2022
1 parent 1c37ce3 commit 7e3baeb
Showing 1 changed file with 24 additions and 23 deletions.
47 changes: 24 additions & 23 deletions README.md → docs/README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,19 @@
<h2 align="center">
<a href="https://github.com/z-shell/zi">
<img src="https://github.com/z-shell/zi/raw/main/docs/images/logo.svg" alt="Logo" width="80" height="80">
</a>
❮ ZI ❯ Package - Zsh-bin
</h2>

<h2 align="center">

<div align="center" width="100%"><table>
<tr><td align="center"><a href="https://github.com/z-shell/zi">
<img src="https://github.com/z-shell/zi/raw/main/docs/images/logo.svg" alt="Logo" width="60" height="60" />
</a>
<h2> ❮ ZI ❯ Package - Statically-linked, hermetic, relocatable Zsh </h2>
</tr></td><tr><td align="center"><h2>

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

</h2>

> 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.

<img src="https://user-images.githubusercontent.com/59910950/161060980-8bc70578-e086-4a51-8cd4-ed3d7289f216.gif" alt="Logo" width="auto" height="440" />
</td></tr></table></div>

The package provides the [romkatv/zsh-bin](https://github.com/romkatv/zsh-bin) statically-linked, hermetic, relocatable Zsh
## Install

### Available `pack''` invocations

Expand All @@ -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.

0 comments on commit 7e3baeb

Please sign in to comment.