projects/fisher
1
0
Fork 0
mirror of https://github.com/jorgebucaran/fisher synced 2024-10-05 09:32:37 +02:00
Code Issues Projects Releases Packages Wiki Activity

Revamp 💪 README.

Browse source
This commit is contained in:
Jorge Bucaran 2016-01-15 00:18:58 +09:00 committed by Jorge Bucaran
parent 10d04d6069
commit 8daa71eccc
1 changed files with 7 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -10,40 +10,31 @@
## About
Fisherman is a plugin manager and CLI toolkit for [Fish][fish] to help you build powerful utilities and share your code easily.
**Fisherman** is a fast, modern plugin system and CLI toolkit for [Fish](http://fishshell.com/).
Fisherman uses a [flat tree][flat-tree] structure that adds no cruft to your shell, making it as fast as no Fisherman. The cache mechanism lets you query the index offline and enable or disable plugins as you wish.
Its flat tree architecture adds no cruft to your shell, making it as fast as _no_ Fisherman. The cache mechanism lets you query the index offline and enable or disable plugins as you wish.
Other features include dependency management, great plugin search capabilities and full compatibility with _Tacklebox_, _Wahoo_ and _Oh My Fish_ themes and packages.
Other features include dependency management, great plugin search capabilities and full compatibility with [Tacklebox](https://github.com/justinmayer/tacklebox), [Wahoo](https://github.com/wa) and [Oh My Fish](https://github.com/oh-my-fish?utf8=%E2%9C%93&query=plugin-) themes and plugins.
## Install
```sh
curl -L install.fisherman.sh | fish
```
:beginner: [**Get started**][quickstart].
## Documentation
## Help
Start in the [**Wiki**][docs] for links to the documentation and other guides or jump to the [Quickstart Guide][quickstart] for a simple introduction to Fisherman. For support and feedback join the Slack [room][wharf-link] or browse the [issues][issues].
For usage, examples and guides [see the wiki][wiki]. For support and feedback join the [Wharf][wharf-link] or browse the [issues][issues].
:anchor:
<!-- Links -->
[faq]: https://github.com/fisherman/fisherman/wiki/FAQ
[fish]: https://github.com/fish-shell/fish-shell
[docs]: https://github.com/fisherman/fisherman/wiki
[intro]: man/man7/fisher-tour.md
[issues]: http://github.com/fisherman/fisherman/issues
[wiki]: https://github.com/fisherman/fisherman/wiki
[quickstart]: https://github.com/fisherman/fisherman/wiki/Quickstart-Guide
[flat-tree]: https://github.com/fisherman/fisherman/blob/master/man/man7/fisher-tour.md#flat-tree
[wharf-link]: https://fisherman-wharf.herokuapp.com/
[fisher-tour]: man/man7/fisher-tour.md
[wharf-badge]: https://img.shields.io/badge/wharf-join%20the%20chat-00cc99.svg?style=flat-square
[screencasts]: https://github.com/fisherman/fisherman/wiki/Screencasts
[travis-link]: https://travis-ci.org/fisherman/fisherman
[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg?style=flat-square
[fisherman-version]: https://img.shields.io/badge/fisherman-v0.4.0-00B9FF.svg?style=flat-square