Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ss-o committed Apr 5, 2022
1 parent 33aad3d commit 94119c5
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<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">
<img src="https://github.com/z-shell/zi/raw/main/docs/images/logo.svg" alt="Logo" width="80" height="80" />
</a>
❮ ZI ❯ Special Package - Any Gem
</h2>
Expand All @@ -13,17 +13,6 @@

</h3>

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

## The `any-gem` Package

This package is special – it is designed for easy installing of any Ruby Gems locally inside the plugin directory,
Expand Down Expand Up @@ -58,3 +47,17 @@ zi lucid id-as="${${:-%IDAS%}:-%GEM%}" as=null \
sbin="n:bin/*" for \
z-shell/null
```

---


> 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 94119c5

Please sign in to comment.