Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
mkusher committed Aug 3, 2015
1 parent 847e460 commit fd38aec
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ Padawan.vim is a vim plugin for [padawan.php server
](https://github.com/mkusher/padawan.php).

This plugin includes:
- Omnifunc(it is terrible, I'm using [this YCMD client
](https://gist.github.com/mkusher/43bcff85d5e2f3ec3c55) instead)
- Omnifunc
- Index generation and saving commands
- Server manipulating commands(start, stop, restart)

Expand All @@ -17,6 +16,7 @@ You should have:

1. PHP 5.4+
2. Composer(accesible via `composer` command in bash)
3. Vim with +python

Installation
------------
Expand Down Expand Up @@ -50,6 +50,21 @@ cd padawan.php
php composer.phar install
```

Usage
-----

Open your php project that uses composer and then run
```
:call padawan#GenerateIndex()
```

It can take a while. You should generate index manually for each of your
project only one time. After it start server with
```
:call padawan#StartServer()
```
And that's all!

Vim functions
-------------

Expand Down

0 comments on commit fd38aec

Please sign in to comment.