Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 7788a93

Browse files
committed
Adding LICENSE & improving README
1 parent a8c998e commit 7788a93

2 files changed

Lines changed: 48 additions & 1 deletion

File tree

LICENSE

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) <2013> Grégoire Passault
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is furnished
8+
to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,32 @@ RST
33

44
PHP library to parse reStructuredText document
55

6-
*Note: This is a really minimalistic library and a work in progress*
6+
*NOTE: This is a work in progress, the library is not finished at all and then
7+
not documented, if you want to contribute or bring idea, don't hesitate to post
8+
me a message or on the issues tracking*
9+
10+
Usage
11+
-----
12+
13+
The parser can be used this way:
14+
15+
```php
16+
<?php
17+
18+
use Gregwar\RST\Parser;
19+
20+
// Loading document
21+
$data = file_get_contents('document.rst');
22+
23+
// Parsing it
24+
$parser = new Parser;
25+
$document = $parser->parse($data);
26+
27+
// Rendering it
28+
echo $document;
29+
```
30+
31+
License
32+
-------
33+
34+
This library is under MIT license

0 commit comments

Comments
 (0)