From 1cfe9f30bc6bf3eb3faf7ca895ce9d1acfc700e1 Mon Sep 17 00:00:00 2001 From: Jorge Bucaran Date: Fri, 15 Jan 2016 00:18:58 +0900 Subject: [PATCH] Revamp :muscle: README. --- README.md | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 14106e2..c9e7040 100644 --- a/README.md +++ b/README.md @@ -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: - [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