diff --git a/README.md b/README.md index f772d99..af3d85e 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,51 @@

- - Fisherman - + + Fisherman +

+ + [![Build Status][travis-badge]][travis-link] -![Fisherman Version][fisherman-version] +[![Fisherman Version][version-badge]][version-link] [![Wharf][wharf-badge]][wharf-link] + ## About **Fisherman** is a blazing [fast](#performance), modern plugin manager for [Fish](http://fishshell.com/). - Features include a flat tree dependency model, external self-managed database, cache mechanism, great test coverage and compatibility with Tackle, Oh My Fish! and Wahoo themes and plugins. -:point_right: [**Get Started**][quickstart] +  :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. +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][fundle] performs well, but still [runs][fundle-slow] cumbersome startup code. Oh My Fish! has by far the worst performance at `0.21s`. - -To learn more about these benchmarks, see [Performance][performance]. +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.21s`.

- + Performance +
+ SEE MORE +

@@ -43,23 +55,33 @@ To learn more about these benchmarks, see [Performance][performance]. For documentation and guides [see the wiki][wiki]. For questions and feedback join the Slack [room][wharf-link] or browse the [issues][issues]. + :anchor: - - -[faq]: https://github.com/fisherman/fisherman/wiki/FAQ -[fish]: https://github.com/fish-shell/fish-shell -[docs]: https://github.com/fisherman/fisherman/wiki -[wiki]: https://github.com/fisherman/fisherman/wiki -[index]: https://github.com/fisherman/fisher-index -[issues]: http://github.com/fisherman/fisherman/issues -[fundle]: https://github.com/tuvistavie/fundle/ -[quickstart]: https://github.com/fisherman/fisherman/wiki/Quickstart-Guide -[wharf-link]: https://fisherman-wharf.herokuapp.com/ -[wharf-badge]: https://img.shields.io/badge/Slack-join%20the%20chat-00cc99.svg?style=flat-square -[fundle-slow]: https://github.com/tuvistavie/fundle/blob/master/functions/fundle.fish#L232 -[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/latest-v0.5.0-00B9FF.svg?style=flat-square -[performance]: https://github.com/fisherman/fisherman/wiki/Performance + + + +[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.5.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 + + + + +[fish]: https://github.com/fish-shell/fish-shell +[quickstart]: https://github.com/fisherman/fisherman/wiki/Quickstart-Guide + + + + +[fundle]: https://github.com/tuvistavie/fundle/blob/master/functions/fundle.fish#L232 +[performance]: https://github.com/fisherman/fisherman/wiki/Performance + + + +[wiki]: https://github.com/fisherman/fisherman/wiki +[issues]: http://github.com/fisherman/fisherman/issues