Skip to content

Commit

Permalink
Readme update 05 31 (#168)
Browse files Browse the repository at this point in the history 
* Update README.md
  • Loading branch information
@ss-o
ss-o authored Jun 4, 2022
1 parent b54fe9e commit 332be4c
Showing 1 changed file with 237 additions and 153 deletions.
390 changes: 237 additions & 153 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,158 +1,242 @@
<table style="width:100%;height:auto">
<tr><td align="center">
<h1><a title="❮ ZI ❯" target="_self" href="/~https://github.com/z-shell/zi">
<img style="width:60px;height:60px"
src="https://raw.githubusercontent.com/z-shell/zi/main/docs/images/favicon.svg"
alt="Logo" /></a>❮ ZI ❯
</h1>
<h2>
A Swiss Army Knife for <a href="https://zsh.sourceforge.io/">Zsh</a> -
<a href="https://en.wikipedia.org/wiki/Unix_shell">Unix Shell</a>
</h2>
<h3>
<a href="/~https://github.com/z-shell/zi/issues/new?assignees=&labels=bug+%F0%9F%90%9E&template=01_bug_report.yml&title=bug%3A+">《 Report an issue 》</a> ·
<a href="/~https://github.com/z-shell/zi/issues/new?assignees=&labels=feature-request+%F0%9F%92%A1&template=02_feature_request.yml&title=feat%3A+">《 Request a Feature 》</a> · <a href="/~https://github.com/orgs/z-shell/discussions">《 Ask a Question 》</a>
</h3>
<h3>
<div align="justify"><table style="width: 100%; height: auto">
<tr><td align="center">
<h1><a target="_self" href="/~https://github.com/z-shell/zi">
<img style="width: 60px; height: 60px" src="https://raw.githubusercontent.com/z-shell/zi/main/docs/images/favicon.svg"
alt="❮ ZI ❯ Logo" /></a>❮ ZI ❯</h1><h2> A Swiss Army Knife for <a href="https://zsh.sourceforge.io/">Zsh</a> -
<a href="https://en.wikipedia.org/wiki/Unix_shell">Unix Shell</a></h2><p>
<a href="/~https://github.com/z-shell/zi/issues/new?assignees=&labels=bug+%F0%9F%90%9E&template=01_bug_report.yml&title=bug%3A+">《 Report an issue </a>
·
<a href="/~https://github.com/z-shell/zi/issues/new?assignees=&labels=feature-request+%F0%9F%92%A1&template=02_feature_request.yml&title=feat%3A+">《 Request a Feature 》</a>
·
<a href="/~https://github.com/orgs/z-shell/discussions">《 Ask a Question 》</a></p>
<a href="https://z.digitalclouds.dev/search/">《💡》Search Wiki </a>
<a href="https://z.digitalclouds.dev/docs/getting_started/installation/">《⚡️》 Install</a>
<a href="/~https://github.com/z-shell/community/issues/new?assignees=&labels=%F0%9F%91%A5+member&template=membership.yml&title=team%3A+">《💜》Join </a>
<a href="https://crowdin.digitalclouds.dev/z-shell/">《🌐》Localize </a>
</h3>
</tr><tr><td align="center">
<a title="Crowdin" target="_self" href="https://crowdin.digitalclouds.dev/z-shell">
<img align="center" src="https://badges.crowdin.net/e/f108c12713ee8526ac878d5671ad6e29/localized.svg" />
</a>
<a title="Gitter" target="_self" href="https://gitter.im/z-shell/zi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
<img align="center" src="https://badges.gitter.im/z-shell/zi.svg" />
</a>
<a title="Releases" target="_self" href="/~https://github.com/z-shell/zi/releases">
<img align="center" src="https://img.shields.io/github/tag/z-shell/zi.svg" alt="Version" />
</a>
<a title="License" target="_self" href="/~https://github.com/z-shell/zi/blob/main/LICENSE">
<img align="center" src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Project License" />
</a>
<a title="VIM" target="_self" href="/~https://github.com/z-shell/zi-vim-syntax/">
<img align="center" src="https://img.shields.io/badge/--019733?logo=vim" alt="VIM" />
</a>
<a title="ZI" target="_self" href="https://open.vscode.dev/z-shell/zi/">
<img align="center"
src="https://img.shields.io/badge/--007ACC?logo=visual%20studio%20code&logoColor=ffffff" alt="Visual Studio Code" />
</a>
<a href="/~https://github.com/z-shell/community/issues/new?assignees=&labels=%F0%9F%91%A5+member&template=membership.yml&title=team%3A+">《💜》Join</a>
<a href="https://crowdin.digitalclouds.dev/z-shell/">《🌐》Localize </a></td></tr>
<tr><td align="center">
<p><a target="_self" href="/~https://github.com/z-shell/status/actions?query=workflow%3A%22Uptime+CI%22">
<img align="center" src="/~https://github.com/z-shell/status/workflows/Uptime%20CI/badge.svg" alt="Uptime CI"/>
</a>
<a target="_self" href="/~https://github.com/z-shell/status/actions?query=workflow%3A%22Response+Time+CI%22">
<img
align="center"
src="/~https://github.com/z-shell/status/workflows/Response%20Time%20CI/badge.svg"
alt="Response Time CI"
/>
</a>
<a target="_self" href="/~https://github.com/z-shell/status/actions?query=workflow%3A%22Graphs+CI%22">
<img
align="center"
src="/~https://github.com/z-shell/status/workflows/Graphs%20CI/badge.svg"
alt="Graphs CI"
/>
</a>
<a target="_self" href="/~https://github.com/z-shell/uptime-status/actions?query=workflow%3A%22Summary+CI%22">
<img
align="center"
src="/~https://github.com/z-shell/status/workflows/Summary%20CI/badge.svg"
alt="Summary CI"
/>
</a>
</p>
<a
title="Crowdin"
target="_self"
href="https://crowdin.digitalclouds.dev/z-shell"
>
<img
align="center"
src="https://badges.crowdin.net/e/f108c12713ee8526ac878d5671ad6e29/localized.svg"
/>
</a>
<a
title="Gitter"
target="_self"
href="https://gitter.im/z-shell/zi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"
>
<img align="center" src="https://badges.gitter.im/z-shell/zi.svg" />
</a>
<a
title="Releases"
target="_self"
href="/~https://github.com/z-shell/zi/releases"
>
<img
align="center"
src="https://img.shields.io/github/tag/z-shell/zi.svg"
alt="Version"
/>
</a>
<a
title="License"
target="_self"
href="/~https://github.com/z-shell/zi/blob/main/LICENSE"
>
<img
align="center"
src="https://img.shields.io/badge/License-MIT-blue.svg"
alt="Project License"
/>
</a>
<a
title="VIM"
target="_self"
href="/~https://github.com/z-shell/zi-vim-syntax/"
>
<img
align="center"
src="https://img.shields.io/badge/--019733?logo=vim"
alt="VIM"
/>
</a>
<a target="_self" href="https://open.vscode.dev/z-shell/zi/">
<img
align="center"
src="https://img.shields.io/badge/--007ACC?logo=visual%20studio%20code&logoColor=ffffff"
alt="Visual Studio Code"
/>
</a>
<p/>
</td>
</tr>

<tr>
<td align="center">
<img
align="center"
style="width: 80%; height: auto"
src="/~https://github.com/z-shell/.github/raw/main/metrics/plugin/followup/zi_followup.svg"
/>
<img
align="center"
style="width: 80%; height: auto"
src="https://raw.githubusercontent.com/z-shell/.github/main/metrics/metrics.svg"
/>
<img
align="center"
style="width: 80%; height: auto"
src="/~https://github.com/z-shell/.github/raw/main/metrics/plugin/projects/projects.svg"
/>
</td>
</tr>
<tr>
<td align="center">
<a title="ZI WIKI" target="_self" href="/~https://github.com/z-shell/zw">
<img
align="center"
style="width: 80%; height: auto"
src="/~https://github.com/z-shell/.github/raw/main/metrics/plugin/pagespeed/detailed.svg"
/>
</a>
</td>
</tr>
<tr>
<td align="center">
<a title="ZI" target="_self" href="https://twitter.com/zshell_zi">
<img
align="center"
style="width: 80%; height: auto"
src="https://raw.githubusercontent.com/z-shell/.github/main/metrics/plugin/tweets/tweets.svg"
/>
</a>
<a href="https://dev.to/z-shell/">
<img
align="center"
style="width: 80%; height: auto"
src="https://raw.githubusercontent.com/z-shell/.github/main/metrics/plugin/rss/ops.io.zsh.svg"
/>
</a>
<!-- <a href="https://dev.to/tag/zsh/">
<img
align="center"
style="width: 80%; height: auto"
src="https://raw.githubusercontent.com/z-shell/.github/main/metrics/plugin/rss/dev.tag.zsh.rss.svg"
/>
</a> -->
</td>
</tr>
<tr>
<td align="center">
<a href="https://asciinema.org/a/459358" target="_blank"
><img
style="width: 100%; height: auto"
src="https://asciinema.org/a/459358.svg"
/></a>
</td>
</tr>
<table>
<tr>
<td align="left">
<hr />
<h2>Roadmap</h2>
<p><a href="/~https://github.com/z-shell/zi/issues">See the open issues</a> for a list of proposed features or subjects that needs the support</p>
<p><a href="/~https://github.com/z-shell/zi/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc">Top feature requests</a> - add your votes using the 👍 reaction) </p>
<p><a href="/~https://github.com/z-shell/zi/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc">Top issues</a> - add your votes using the 👍 reaction </p>
<p><a href="/~https://github.com/z-shell/zi/issues?q=is%3Aopen+is%3Aissue+label%3Abug">Newest issues</a>
<hr />
<h2 align="left">Contributing</h2>
<p> Work in progress Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you
make will benefit everybody else and are <b>greatly appreciated</b> and our <b>target</b> to support each other. Please read <a href="/~https://github.com/z-shell/community/blob/main/docs/project/CONTRIBUTING.md">our contribution guidelines"</a> before you start. Thank you for being involved! </p>
<hr />
<h2 align="left">Project assistance</h2>
<p> If you want to say <b>thank you</b> or/and support the active development.</p>
<p> - Add a <a href="/~https://github.com/z-shell/zi">GitHub Star</a> to the project, and follow <a href="/~https://github.com/z-shell">Z-Shell</a> organization. </p>
<p> - Write interesting articles about the project on: <br />
<a href="https://dev.to/">Dev.to</a>, <a href="https://medium.com/">Medium.com</a>, <a href="https://news.ycombinator.com/news">Hacker News</a>, <a href="https://community.ops.io/zsh">Community.ops.io</a>, <a href="https://www.reddit.com/r/zsh/">Reddit</a>, <a href="https://twitter.com/zshell_zi">Twitter</a> or your blog. Let us know so can share your post, especially if it's in other languages or some interesting zshrc configurations </p>
<p> Participate in the community by showing the <a href="/~https://github.com/z-shell/community/issues/new?assignees=&labels=%F0%9F%91%A5+member&template=membership.yml&title=team%3A+">interst</a> to the project, as it may bring us together, then great things may happen. If you would like to participate, but are not sure about what and how - do not hesitate to contact us so we can discuss the situation 👍. We've all been there, we all had to start from something - together is much easier, just need to do the first step 🚀. </p>
<hr />
<h2 align="left">Security</h2>
<p> - Z-Shell ZI follows good practices of security, but 100% security cannot be assured.</p>
<p> - Z-Shell ZI is provided <bold>"as is"</bold> without any <bold>warranty</bold>. Use at your own risk. </p>
<p> - For more information and to report security issues, please refer to our <a href="/~https://github.com/z-shell/zi/blob/main/docs/SECURITY.md">security documentation</a>.</p>
<hr />
<h2 align="left">Acknowledgements</h2>
<p> The <a href="/~https://github.com/z-shell">Z-Shell</a> organization was created to recover the <a href="/~https://github.com/zdharma">Zdharma</a> organization which was deleted by the owner for an unknown reason. It took a lot of time and offer for all those who liked the project and were depending on it don't want to depend on an unreliable source. </p>
<p> <a href="/~https://github.com/z-shell/zi">ZI</a>, formerly known as zplugin, zinit, is an open-source community project released under the <a href="/~https://github.com/z-shell/zi/blob/main/LICENSE">MIT License</a>.</p>
<hr />
<h2 align="left">Authors & contributors</h2>
<p> Check the list of authors and contributors in this <a href="/~https://github.com/z-shell/zi/contributors">repository</a> and also all other repositories under <a href="/~https://github.com/z-shell">Z-Shell</a> organization. We will inlclude all showning the interest or dedicated their time to take a part.
</p>
</td></tr>
<tr><td align="center">
<img align="center" style="width:80%;height:auto"
src="/~https://github.com/z-shell/.github/raw/main/metrics/plugin/followup/zi_followup.svg"
/>
<img align="center" style="width:80%;height:auto"
src="https://raw.githubusercontent.com/z-shell/.github/main/metrics/metrics.svg"
/>
<img align="center" style="width:80%;height:auto"
src="/~https://github.com/z-shell/.github/raw/main/metrics/plugin/projects/projects.svg"
/>
</td>
</tr>
<tr>
<td align="center">
<a title="ZI WIKI" target="_self" href="/~https://github.com/z-shell/zw">
<imgn align="center" style="width:80%;height:auto"
src="/~https://github.com/z-shell/.github/raw/main/metrics/plugin/pagespeed/detailed.svg"
/>
</a>
</td></tr>
<tr><td align="center">
<a title="ZI" target="_self" href="https://twitter.com/zshell_zi">
<img align="center" style="width:80%;height:auto"
src="https://raw.githubusercontent.com/z-shell/.github/main/metrics/plugin/tweets/tweets.svg"
/>
</a>
<a href="https://dev.to/z-shell/">
<img align="center" style="width:80%;height:auto"
src="https://raw.githubusercontent.com/z-shell/.github/main/metrics/plugin/rss/dev.zshell.rss.svg"
/>
</a>
<a href="https://dev.to/tag/zsh/">
<img align="center" style="width:80%;height:auto"
src="https://raw.githubusercontent.com/z-shell/.github/main/metrics/plugin/rss/dev.tag.zsh.rss.svg"
/>
</a>
</td></tr>
<tr><td align="center">
<a href="https://asciinema.org/a/459358" target="_blank"><img style="width:100%;height:auto" src="https://asciinema.org/a/459358.svg" /></a>
</td></tr>
<tr><td align="left"><div>

## Roadmap

See the [open issues](/~https://github.com/z-shell/zi/issues) for a list of proposed features (and known
issues).

- [Top Feature
Requests](/~https://github.com/z-shell/zi/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
(Add your votes using the 👍 reaction)
- [Top
issues](/~https://github.com/z-shell/zi/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)
(Add your votes using the 👍 reaction)
- [Newest issues](/~https://github.com/z-shell/zi/issues?q=is%3Aopen+is%3Aissue+label%3Abug)

## Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community
such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else
and are **greatly appreciated**.

Please read [our contribution
guidelines](/~https://github.com/z-shell/community/blob/main/docs/project/CONTRIBUTING.md), and thank you for
being involved!

## Project assistance
<tr>
<td align="center">
<h2 align="left">Credits</h2>
<a href="https://trunk.io" rel="nofollow">
<img
style="width: 140; height: 40px"
src="https://storage.googleapis.com/digital-space/img/brand/trunk/trunk-white.svg"
alt="Trunk"
/>
</a>
<a
href="https://crowdin.com/?utm_source=badge&utm_medium=referral&utm_campaign=badge-add-on"
rel="nofollow"
>
<img
style="width: 140; height: 40px"
src="https://storage.googleapis.com/digital-space/img/brand/crowdin/localization-at-dark-rounded%402x.png"
alt="Crowdin | Agile localization for tech companies"
/>
</a>
<a
href="https://www.digitalocean.com/?refcode=090bdb63f800&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge"
rel="nofollow"
>
<img
style="width: 140; height: 40px"
src="https://web-platforms.sfo2.digitaloceanspaces.com/WWW/Badge%203.svg"
alt="DigitalOcean Referral Badge"
/>
</a>
<a href="https://cloudflare.com" rel="nofollow">
<img
style="width: 140; height: 40px"
src="https://storage.googleapis.com/digital-space/img/brand/cloudflare/cf-logo-v-rgb.png"
alt="Cloudflare"
/>
</a>
</td>
</tr>
</table></div>

If you want to say **thank you** or/and support the active development of ZI.

- Add a [GitHub Star](/~https://github.com/z-shell/zi) to the project.
- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or
your personal blog.
- **Become a part** -
[join](/~https://github.com/z-shell/community/issues/new?assignees=&labels=%F0%9F%91%A5+member&template=membership.yml&title=team%3A+)
the project and bring your parts **together!** :)

## Security

- Z-Shell ZI follows good practices of security, but 100% security cannot be assured.
- Z-Shell ZI is provided **"as is"** without any **warranty**. Use at your own risk.

_For more information and to report security issues, please refer to our [security
documentation](/~https://github.com/z-shell/zi/blob/main/docs/SECURITY.md)._

## Acknowledgements

The [**Z-Shell**](/~https://github.com/z-shell) was created to recover the `zdharma` organization project which
was deleted by the owner.
We don't want to depend on an unreliable source.
[**ZI**](/~https://github.com/z-shell/zi), formerly known as zplugin, zinit, is an open-source community project
released under the [MIT License](/~https://github.com/z-shell/zi/blob/main/LICENSE).

## Authors & contributors

The original setup of this repository is by [@ss-o](/~https://github.com/ss-o).

For a full list of all authors and contributors, see [the contributors
page](/~https://github.com/z-shell/zi/contributors).

<div></td>
</tr>
<tr><td align="center"><h2 align="left">Credits</h2>
<a href="https://trunk.io" rel="nofollow">
<img style="width:140;height:40px" src="https://storage.googleapis.com/digital-space/img/brand/trunk/trunk-white.svg" alt="Trunk" />
</a>
<a href="https://crowdin.com/?utm_source=badge&utm_medium=referral&utm_campaign=badge-add-on" rel="nofollow">
<img style="width:140;height:40px" src="https://space.ss-o.workers.dev/img/brand/crowdin/localization-at-dark-rounded@2x.png" srcset="https://badges.crowdin.net/badge/light/crowdin-on-dark.png 1x,https://badges.crowdin.net/badge/light/crowdin-on-dark@2x.png 2x"alt="Crowdin | Agile localization for tech companies" />
</a>
<a href="https://www.digitalocean.com/?refcode=090bdb63f800&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge" rel="nofollow">
<img style="width:140;height:40px" src="https://web-platforms.sfo2.digitaloceanspaces.com/WWW/Badge%203.svg" alt="DigitalOcean Referral Badge" />
</a>
<a href="https://cloudflare.com" rel="nofollow">
<img style="width:140;height:40px" src="https://storage.googleapis.com/digital-space/img/brand/cloudflare/cf-logo-v-rgb.png" alt="Cloudflare" />
</a>
</td></tr>
</table>

0 comments on commit 332be4c

Please sign in to comment.