Skip to content

Commit

Permalink
Merge branch 'master' of github.com:x-team/wp-plugin-dev-lib
Browse files Browse the repository at this point in the history
  • Loading branch information
westonruter committed Oct 7, 2013
2 parents 2e1b928 + 0e07a75 commit c98d9c4
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,21 @@ wp-plugin-dev-lib

It is intended that this repo be included in plugin repo via git-subtree/submodule in a `bin/` directory.

Symlink to `pre-commit` from your project's `.git/hooks/pre-commit`
Symlink to the `.travis.yml` and `.jshintrc` inside of the same directory:

Includes a WordPress README [parser](class-wordpress-readme-parser.php) and [converter](generate-markdown-readme) to Markdown,
```bash
ln -s bin/.travis.yml . && git add .travis.yml
ln -s bin/.jshintrc . && git add .jshintrc
```

Symlink to `pre-commit` from your project's `.git/hooks/pre-commit`:

```bash
cd .git/hooks
ln -s ../../bin/pre-commit .
```

The library includes a WordPress README [parser](class-wordpress-readme-parser.php) and [converter](generate-markdown-readme) to Markdown,
so you don't have to manually keep your `readme.txt` on WordPress.org in sync with the `readme.md` you have on GitHub. The
converter will also automatically recognize the presence of projects with Travis CI and include the status image
in the markdown. Screenshots and banner images for WordPress.org are also automatically incorporated into the `readme.md`.
Expand Down

0 comments on commit c98d9c4

Please sign in to comment.