maciej/counsel-projectile
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme: add MELPA badge + contributors

Browse source
This commit is contained in:
Eric Danan 2016-04-15 00:05:49 +02:00
parent 5633ca5615
commit a724fc0941
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -1,3 +1,5 @@
[![MELPA](https://melpa.org/packages/counsel-projectile-badge.svg)](https://melpa.org/#/counsel-projectile)
# Description
This library tries to do something similar to `helm-projectile`, but using `ivy` instead of `helm`. The main function is `counsel-projectile`.
@ -11,3 +13,7 @@ Install the package from `MELPA` or `el-get`, or clone this repository somewhere
The main function is `counsel-projectile`. It starts an `ivy-read` session with the list of `projectile` known projects as candidates. The current project, if any, comes first in this list. The default action switches to the selected project (therefore calling `projectile-switch-project-action`). There are several additional actions to swich project with a specific `projectile-switch-project-action` (eg `projectile-vc`). The action list can be customized since `ivy-read` is called with `:caller 'counsel-projectile`.
In the action list, a new function `counsel-projectile-find-file` is used instead of the standard `projectile-find-file`. It simply proposes an additional action to find the file in another window (thus bringing together `projectile-find-file` and `projectile-find-file-other-window`). You may also call this function directly or bind it to some key. Similarly for two other new functions: `counsel-projectile-find-dir` and `counsel-projectile-switch-to-buffer`.
# Contributors
Many thanks to @abo-abo and @DamienCassou who encouraged and helped me to start this repository.