Skip to content

Commit

Permalink
Added better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
marekdedic authored Oct 28, 2019
1 parent 06008a0 commit 10e8ef9
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,27 @@

[![CircleCI branch](https://img.shields.io/circleci/project/github/marekdedic/phan-wordpress-stubs/master.svg)](https://circleci.com/gh/marekdedic/workflows/phan-wordpress-stubs/tree/master)

This repo contains stubs for WordPress functions and classes to be used with phan.
This repo contains stubs for WordPress functions and classes to be used with [phan](https://github.com/phan/phan), the PHP static analyzer. This allows for better type-checking of a codebase as the stubs all have type information.

## Installation

```sh
$ composer require --dev skaut/phan-wordpress-stubs
```

Add to your '.phan/config.php':

```php
return [
'directory_list' => [
'vendor/skaut/phan-wordpress-stubs/stubs'
],
'exclude_analysis_directory_list' => [
'vendor/skaut/phan-wordpress-stubs/stubs'
]
];
```

## Completeness

The stubs are not complete. If you spot any missing functions or classes, please [open an issue](https://github.com/skaut/phan-wordpress-stubs/issues/new).

0 comments on commit 10e8ef9

Please sign in to comment.