Skip to content

Commit ee65126

Browse files
committed
formatting
1 parent 19eca69 commit ee65126

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ compiler to PHP.
77

88
CoffeeScript version **1.3.1** has been fully ported over (see
99
[tags](http://github.com/alxlit/coffeescript-php/tags)). Compiled code nearly
10-
matches the reference 100%, except for [#11](https://github.com/alxlit/coffeescript-php/issues/11)
11-
(a good thing).
10+
matches the reference 100%, except for one or two benign differences (for
11+
example [#11](https://github.com/alxlit/coffeescript-php/issues/11)).
1212

1313
## Requirements
1414

@@ -32,8 +32,16 @@ CoffeeScript\Init::load();
3232

3333
## Usage
3434

35-
The API is really basic (single `compile` function). I don't plan on expanding
36-
it further (keep it simple).
35+
The API is really basic (single `compile($coffee, $options = NULL)` function).
36+
I don't plan on expanding it further (keep it simple).
37+
38+
Available options:
39+
40+
* **filename** - The source filename, formatted into error messages
41+
* **header** - Add a "Generated by..." header
42+
* **rewrite** - Enable the rewriter (debugging)
43+
* **tokens** - Reference to token stream (debugging)
44+
* **trace** - File to write parser trace to (debugging)
3745

3846
```php
3947
<?php
@@ -55,14 +63,6 @@ catch (Exception $e)
5563
?>
5664
```
5765

58-
Available options:
59-
60-
* **filename** - The source filename, formatted into error messages
61-
* **header** - Add a "Generated by..." header
62-
* **rewrite** - Enable the rewriter (debugging)
63-
* **tokens** - Reference to token stream (debugging)
64-
* **trace** - File to write parser trace to (debugging)
65-
6666
## Development
6767

6868
To rebuild the parser run `php make.php`. Tests are run in the browser; simply

0 commit comments

Comments
 (0)