fisher/README.md
Jorge Bucaran 5dc1eea953
Ahoy! an early v0.7.0 is here!
+ Add  the ability  to install plugins  from Gists.  You can
distribute a very simple,  one-single function plugin in the
form  of a  Gist. Your  users  can install  it using  fisher
install  url and  Fisherman will  query the  Gist using  the
GitHub API to get a list of  the Gist files and use the name
of the  first identified *.fish  file to name the  plugin in
your system.  Since there is no  formal way to name  a Gist,
and you may  prefer to keep the "description"  field for the
actual description  and not a name,  Fisherman supports only
one fish file per Gist. Closes #75.

+ Use command(1) when calling non-builtins. Thanks @daenney.
Closes #79.

+  Add  __fisher_plugin_can_enable  to detect  installing  a
prompt that is not the current one. Closes #78.

+  Remove  the ability  to  install  a  plugin in  a  parent
directory using ..  or ../ or even worse, ../../  as well as
other combinations  that navigate  to a parent  directory. I
find  the use  case odd  at  best, and  more dangerous  that
useful.  If you  want  to  install a  local  plugin use  the
full  path  or a  relative  path,  always top  down.  fisher
install  . or  fisher  install my/plugin  or fisher  install
/Users/$USER/path/to/plugin. Closes #81.
2016-02-11 09:40:03 +09:00

78 lines
2.7 KiB
Markdown

<a name="fisherman"></a>
<p align="center">
<br>
<a href="http://fisherman.sh">
<img
alt="Fisherman"
width=660px
src="https://rawgit.com/fisherman/logo/master/fisherman-black-white.svg">
</a>
<br>
<br>
<br>
</p>
[![Build Status][travis-badge]][travis-link]
[![Fisherman Version][version-badge]][version-link]
[![Wharf][wharf-badge]][wharf-link]
<hr>
**Fisherman** is a blazing [fast](#performance), modern plugin manager for [Fish](http://fishshell.com/).
Features include a flat tree dependency model, external self-managed index, cache mechanism, full test coverage and compatibility with Tackle, Oh My Fish! and Wahoo themes and plugins.
&nbsp; :point_right: [**Get Started**][quickstart]
## Performance
The following benchmarks were calculated using a 2.4 GHz Intel Core i5 MacBook Pro running on Flash Storage. See [Performance][performance] to learn more.
```fish
time -p fish -ic exit
```
Fisherman runs virtually no initialization code making it as fast as no Fisherman. Fundle performs well, but still [runs][fundle] cumbersome startup code. Oh My Fish! has the worst performance at `0.21` seconds for a lightweight setup.
<p align="center">
<a href="https://github.com/fisherman/fisherman/wiki/Performance">
<img
alt="Performance"
width=65%
src="https://cloud.githubusercontent.com/assets/8317250/12769643/c6e2db4e-ca5c-11e5-9f4e-7d90cd072063.png">
<br>
<sup><sup>SEE MORE</sup></sup>
</a>
</p>
## Documentation
For documentation and guides [see the wiki][wiki]. For questions and feedback join the Slack [room][wharf-link] or browse the [issues][issues].
:anchor:
<!-- Header -->
[travis-link]: https://travis-ci.org/fisherman/fisherman
[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg?style=flat-square
[version-badge]: https://img.shields.io/badge/latest-v0.6.0-00B9FF.svg?style=flat-square
[version-link]: https://github.com/fisherman/fisherman/releases
[wharf-link]: https://fisherman-wharf.herokuapp.com/
[wharf-badge]: https://img.shields.io/badge/slack-join%20the%20chat-00cc99.svg?style=flat-square
<!-- About -->
[fish]: https://github.com/fish-shell/fish-shell
[quickstart]: https://github.com/fisherman/fisherman/wiki/Quickstart-Guide
<!-- Performance -->
[fundle]: https://github.com/tuvistavie/fundle/blob/master/functions/fundle.fish#L232
[performance]: https://github.com/fisherman/fisherman/wiki/Performance
<!-- Documentation -->
[wiki]: https://github.com/fisherman/fisherman/wiki
[issues]: http://github.com/fisherman/fisherman/issues