Skip to content

Commit 567097f

Browse files
committed
updated README.md information
Added demo video and fixed some typos
1 parent cf7ebd4 commit 567097f

1 file changed

Lines changed: 10 additions & 14 deletions

File tree

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,15 @@ Padawan.php is an http server that parses your project and gives you
2222
completions.
2323
Padawan.php reads autoload classmap of a composer project, parses
2424
doc-comments and functions declarations of each class and creates index
25-
from them. After that it autoupdated index and give you completion
26-
as you send requests to http.
25+
from them. After that it autoupdates index and give you completion
26+
as you type.
2727

28-
* See documentation of current word, be it class name, method or property. It is
29-
context aware.
30-
* Go to definition of a symbol. Also context aware.
31-
* Automatically add use statement of current completed word. Also added plugin
32-
command of this action.
28+
### Demo video
29+
See this short video to see how it works with vim(image is clickable):
30+
[![ScreenShot](http://i1.ytimg.com/vi/Y54P2N1T6-I/maxresdefault.jpg)](https://www.youtube.com/watch?v=Y54P2N1T6-I)
3331

34-
35-
Why not original plugin
36-
-----------------------
32+
Why not the original plugin
33+
---------------------------
3734

3835
The M2mdas's plugin is pretty good, but have some core bugs due to
3936
self-written parser:
@@ -50,13 +47,12 @@ So, I decided to write my own plugin.
5047
Roadmap
5148
-------
5249

53-
As of now this plugin sucks, but I'm working hard on it and these features are
50+
As of now this plugin can do basic things
5451
now in progress:
5552

56-
* Fix bugs with symbol type detection
53+
* Fix interfaces parsing
5754
* Fix plugin user interface
58-
* Add doc-comment parsing
59-
* Add class inheritance indexing
55+
* Add plugins for editors(vim, emacs)
6056
* Add plugins support
6157
* Add symfony2 plugin
6258

0 commit comments

Comments
 (0)