branch: externals/phpinspect
commit 825a3de2c4931d57f6248c6dd90f23bf32b5b513
Author: Hugo Thunnissen <de...@hugot.nl>
Commit: Hugo Thunnissen <de...@hugot.nl>
Add indexation command to mode docstring + add install to readme
---
README.md | 11 +++++++++++
phpinspect.el | 4 ++++
2 files changed, 15 insertions(+)
diff --git a/README.md b/README.md
index 54004ff11b..58a3b259e3 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,17 @@ Example config:
(add-hook 'php-mode-hook #'my-php-personal-hook)
```
+## Install
+
+```bash
+git clone https://git.sr.ht/~hugot/phpinspect.el ~/projects/phpinspect.el
+```
+
+```elisp
+(add-to-list 'load-path "~/projects/phpinspect.el")
+(require 'phpinspect)
+```
+
## Development
### Running tests
diff --git a/phpinspect.el b/phpinspect.el
index f59dee3d1e..7283de2836 100644
--- a/phpinspect.el
+++ b/phpinspect.el
@@ -1882,6 +1882,10 @@ users will have to use \\[phpinspect-purge-cache]."
"A minor mode for intelligent completion for and interaction
with PHP files.
+To initially index a project, use M-x `phpinspect-index-current-project'
+in a buffer of one of the project files. Project root is detected with
+`phpinspect-project-root-file-list'.
+
For completion see the company-mode backend:
`phpinspect-company-backend'.
