Skip to content

Commit 4689b1f

Browse files
committed
Modify README
1 parent 50a2856 commit 4689b1f

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.org

+16-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
11
* phpstan.el
2+
#+BEGIN_HTML
3+
<a href="http://melpa.org/#/phpstan"><img alt="MELPA: phpstan" src="http://melpa.org/packages/phpstan-badge.svg"></a>
4+
<a href="http://stable.melpa.org/#/phpstan"><img alt="MELPA stable: phpstan" src="http://stable.melpa.org/packages/phpstan-badge.svg"></a>
5+
#+END_HTML
26
Emacs interface to [[https://github.com/phpstan/phpstan][PHPStan]], includes checker for [[http://www.flycheck.org/en/latest/][Flycheck]].
37
** Support version
48
- Emacs 24+
59
- PHPStan latest/dev-master (NOT support 0.9 seriese)
610
** How to install
711
*** Install from MELPA
8-
/TBD/
12+
1. If you have not set up MELPA, see [[https://melpa.org/#/getting-started][Getting Started - MELPA]].
13+
2. ~M-x package-install flycheck-phpstan~
914
** How to use
1015
*** For Flycheck user
11-
/TBD/
16+
#+BEGIN_SRC emacs-lisp
17+
(defun my-php-mode-hook ()
18+
"My PHP-mode hook."
19+
(require 'flycheck-phpstan)
20+
(flycheck-mode t)
21+
(flycheck-select-checker 'phpstan))
22+
23+
(add-hook 'php-mode-hook 'my-php-mode-hook)
24+
#+END_SRC
25+
1226
*** For Flymake user
1327
The function for flymake will be implemented soon. You do not have to depend on flycheck.
1428
*** Using Docker (phpstan/docker-image)

0 commit comments

Comments
 (0)