branch: externals/phpinspect
commit 9513cbc91705c3081c971af58bf5679ea35f498f
Author: Hugo Thunnissen <de...@hugot.nl>
Commit: Hugo Thunnissen <de...@hugot.nl>
Update README
---
README.md | 42 ++++++++++++++++++++++++++++++++++++++++--
1 file changed, 40 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index b5013d5a5b..0037e5ff8e 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,46 @@
# phpinspect.el
+PHPInspect is a minor mode that provides code intelligence for PHP in Emacs. At
+its core is a PHP parser implemented in Emacs Lisp. PHPInspect comes with
+backends for `completion-at-point`, `company-mode` and `eldoc`. A backend for
+`xref` (which provides go-to-definition functionality) is planned to be
+implemented at a later date. The main documentation of the mode is in the
+docstring of the mode itself (`C-h f phpinspect-mode RET` to view, or read it
in
+the source code of [phpinspect.el](phpinspect.el)).
-WIP. More documentation is in the making.
+## Projects and Finding Types
+By default, phpinspect will recognize composer projects and read their
+composer.json files for autoload information which is used to find files in
+which the types/classes/functions you use in your code are defined. It is also
+possible to add an "include directory" of files that should always be read and
+indexed for a certain project. To do this, open a file in a project and run
`M-x
+phpinspect-project-add-include-dir`. You can also edit the list of include
+directories via `M-x customize-goup RET phpinspect RET`.
-## Example config
+## Example Configuration
+If you already have a completion UI setup that is able to use
+`completion-at-point-functions` as completion source, you can basically just
+enable phpinspect-mode and you'll be good to go. An example of a basic mode
hook
+configuration to get the most out of phpinspect is the following:
+
+```elisp
+(defun my-php-personal-hook ()
+ ;; Shortcut to add use statements for classes you use.
+ (define-key php-mode-map (kbd \"C-c u\") 'phpinspect-fix-imports)
+
+ ;; Shortcuts to quickly search/open files of PHP classes.
+ ;; You can make these local to php-mode, but making them global
+ ;; like this makes them work in other modes/filetypes as well, which
+ ;; can be handy when jumping between templates, config files and PHP code.
+ (global-set-key (kbd \"C-c a\") 'phpinspect-find-class-file)
+ (global-set-key (kbd \"C-c c\") 'phpinspect-find-own-class-file)
+
+ ;; Enable phpinspect-mode
+ (phpinspect-mode))
+
+(add-hook 'php-mode-hook #'my-php-personal-hook)
+```
+
+## Example config with company mode setup
```elisp
;;;###autoload
