Skip to content

Commit 93a8033

Browse files
committed
Add usage instructions
1 parent 84808a2 commit 93a8033

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
AST
2-
===
1+
XP Compiler
2+
===========
33

44
[![Build Status on TravisCI](https://secure.travis-ci.org/xp-forge/sequence.svg)](http://travis-ci.org/xp-framework/ast)
55
[![XP Framework Module](https://raw.githubusercontent.com/xp-framework/web/master/static/xp-framework-badge.png)](https://github.com/xp-framework/core)
@@ -9,7 +9,14 @@ AST
99
[![Supports HHVM 3.4+](https://raw.githubusercontent.com/xp-framework/web/master/static/hhvm-3_4plus.png)](http://hhvm.com/)
1010
[![Latest Stable Version](https://poser.pugx.org/xp-framework/ast/version.png)](https://packagist.org/packages/xp-forge/sequence)
1111

12-
Abstract syntax tree
12+
Compiles future PHP to today's PHP.
13+
14+
Usage
15+
-----
16+
After adding the compiler to your project via `composer xp-framework/compiler` classes will be passed through the compiler during autoloading. Code inside files with a *.class.php* ending is considered already compiled; files need to renamed `T.class.php` => `T.php` in order to be picked up.
17+
18+
Example
19+
-------
1320

1421
```php
1522
<?php namespace test;

0 commit comments

Comments
 (0)