Skip to content

Commit 4b151b9

Browse files
committed
restructured README.md
1 parent cdb5570 commit 4b151b9

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

README.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,47 @@
1-
Padawan.php for composer projects
2-
=================================
1+
Padawan.php smart php intelligent code completion for php projects
2+
==================================================================
33

44
[![Join the chat at https://gitter.im/mkusher/padawan.php](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mkusher/padawan.php?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
55

66
[![Build Status](https://travis-ci.org/mkusher/padawan.php.svg?branch=master)](https://travis-ci.org/mkusher/padawan.php)
7-
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mkusher/padawan.php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mkusher/padawan.php/?branch=master)
8-
[![Latest Stable Version](https://poser.pugx.org/mkusher/padawan/v/stable)](https://packagist.org/packages/mkusher/padawan)
97
[![Total Downloads](https://poser.pugx.org/mkusher/padawan/downloads)](https://packagist.org/packages/mkusher/padawan)
8+
[![Latest Stable Version](https://poser.pugx.org/mkusher/padawan/v/stable)](https://packagist.org/packages/mkusher/padawan)
109
[![Latest Unstable Version](https://poser.pugx.org/mkusher/padawan/v/unstable)](https://packagist.org/packages/mkusher/padawan)
10+
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mkusher/padawan.php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mkusher/padawan.php/?branch=master)
1111
[![License](https://poser.pugx.org/mkusher/padawan/license)](https://packagist.org/packages/mkusher/padawan)
1212

13-
Smart php intelligent code completion server for composer projects.
13+
Padawan.php is an http server that parses your project and gives you
14+
completions.
15+
Padawan.php looks recursively for all php files of a composer project, parses
16+
doc-comments and function declarations of each class and creates an index
17+
from them. After that it autoupdates the index and gives you completion
18+
as you type.
19+
20+
Padawan.php can be extended by various plugins, which will bring some
21+
extra completion, framework integrations or so.
22+
[See this paragraph to learn more](https://github.com/mkusher/padawan.php#plugins-for-editors)
23+
1424
It tries to be a [Jedi](https://github.com/davidhalter/jedi-vim),
15-
but currently it's only a padawan.
25+
but currently it's only a padawan :)
1626

17-
This project was inspired by
18-
[phpcomplete-extended by M2mdas](https://github.com/m2mdas/phpcomplete-extended)
19-
and started as a fork with a completely rewritten index generation part.
20-
But as of now it is a completely new project with different design principles
27+
Plugins for editors
28+
-------------------
29+
30+
1. [Vim](https://github.com/mkusher/padawan.vim)
31+
2. [Sublime Text 3](https://github.com/mkusher/padawan.sublime)
32+
33+
If you wish to write your own plugin, vim plugin example may serve
34+
as a source of inspiration. Look at
35+
[wiki page](https://github.com/mkusher/padawan.php/wiki/Editors'-plugins) for
36+
some documentation.
37+
You are welcome to open an issue if you have any questions.
2138

2239
### Demo videos
2340

2441
Watch this short videos to see what it can already do(image is clickable)
2542
[![ScreenShot](http://i1.ytimg.com/vi/qpLJD24DYcU/maxresdefault.jpg)](https://www.youtube.com/watch?v=qpLJD24DYcU)
2643
[![ScreenShot](http://i1.ytimg.com/vi/Y54P2N1T6-I/maxresdefault.jpg)](https://www.youtube.com/watch?v=Y54P2N1T6-I)
2744

28-
Project
29-
=======
30-
31-
Padawan.php is an http server that parses your project and gives you
32-
completions.
33-
Padawan.php looks recursively for all php files of a composer project, parses
34-
doc-comments and function declarations of each class and creates an index
35-
from them. After that it autoupdates the index and gives you completion
36-
as you type.
37-
3845
How to use
3946
==========
4047

@@ -54,18 +61,6 @@ project folder.
5461

5562
Check out how to do this in the plugin documentation for specific editor below.
5663

57-
Plugins for editors
58-
-------------------
59-
60-
1. [Vim](https://github.com/mkusher/padawan.vim)
61-
2. [Sublime Text 3](https://github.com/mkusher/padawan.sublime)
62-
63-
If you wish to write your own plugin, vim plugin example may serve
64-
as a source of inspiration. Look at
65-
[wiki page](https://github.com/mkusher/padawan.php/wiki/Editors'-plugins) for
66-
some documentation.
67-
You are welcome to open an issue if you have any questions.
68-
6964
Plugins(extensions) for padawan.php
7065
-----------------------------------
7166

@@ -76,7 +71,12 @@ Padawan.php can be extended by plugins, there are:
7671
Look at [full plugins list](https://github.com/mkusher/padawan.php/wiki/Plugins-list)
7772

7873
Why not the original plugin
79-
===========================
74+
---------------------------
75+
76+
This project was inspired by
77+
[phpcomplete-extended by M2mdas](https://github.com/m2mdas/phpcomplete-extended)
78+
and started as a fork with a completely rewritten index generation part.
79+
But as of now it is a completely new project with different design principles
8080

8181
M2mdas's plugin is pretty good, but has some core bugs due to
8282
self-written parser:
@@ -94,11 +94,11 @@ Roadmap
9494

9595
Now in progress:
9696

97+
* Add completion for built-in php classes and functions
9798
* Implement `go to definition`, `go to assingment`, `show documentation`
9899
* Add plugins for editors(emacs, sublime text, atom and etc.)
99100
* Extend type guessing(process classes' contructors, class doc-comment, foreach loops)
100101
* Implement index updating
101-
* Add support for non-composer projects
102102

103103
License
104104
-------

0 commit comments

Comments
 (0)