diff --git a/README.md b/README.md index 64e61ca..233dd62 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ -# shsh +# Shsh [![Releases](https://img.shields.io/github/release/soraxas/shsh.svg?label=&color=0366d6)](https://github.com/soraxas/shsh/releases/latest) -A **sh**ell **s**cript **h**andler (**shsh**) for handling and managing shell scripts, functions, standalone binaries, and more. + + +A **sh**ell **s**cripts **h**andler (**shsh**) for managing shell scripts, functions, standalone binaries, and more. Shsh allows you to quickly install shell packages directly from github or other sites. Instead of looking for specific install instructions for each package and messing with your path, shsh will create a central location for -all packages and manage their binaries for you. +all packages and manage their executable, completions files, and man files for you. Shsh is a POSIX-compatible script handler, as a former fork of [basher](https://github.com/basherpm/basher) but was made to works with even the most strict POSIX compliance shell like [Dash](https://wiki.archlinux.org/index.php/Dash). @@ -138,8 +140,10 @@ ZSH_COMPLETIONS=completions/_package BINS specified in this fashion have higher precedence then the inference rules above. +## Credits +- [basher](https://github.com/basherpm/basher) for the wonderful framework -## Credits +- [fisher](https://github.com/jorgebucaran/fisher) for the idea of multi-threaded approach -The wonderful [Basher](https://github.com/basherpm/basher). +- [vim-plug](https://github.com/junegunn/vim-plug) for the inspiration of hooks diff --git a/docs/images/shsh-logo.png b/docs/images/shsh-logo.png new file mode 100644 index 0000000..0a481f4 Binary files /dev/null and b/docs/images/shsh-logo.png differ