From d4ce4fbf86ede97937d4536fc07ad5e79d993f34 Mon Sep 17 00:00:00 2001 From: Eric Danan Date: Wed, 13 Apr 2016 10:40:56 +0200 Subject: [PATCH] wrote a short readme --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d85bce7..e2dec00 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ -# counsel-projectile -Ivy UI for Projectile +# Description + +This library tries to do something similar to `helm-projectile`, but using `ivy` instead of `helm`. The main function is `counsel-projectile`. + +# Installation + +Clone the repository somewhere in your load path. + +# Usage + +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 (calling `projectile-switch-project-action`). There are several additional 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`. \ No newline at end of file