Skip to content

Commit

Permalink
Added BuildStatus to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
heiglandreas committed May 16, 2013
1 parent c024f07 commit e3698a3
Showing 1 changed file with 44 additions and 45 deletions.
89 changes: 44 additions & 45 deletions README → README.md
@@ -1,40 +1,19 @@
README:
[![Build Status](https://travis-ci.org/heiglandreas/Org_Heigl_Hyphenator.png?branch=master)](https://travis-ci.org/heiglandreas/Org_Heigl_Hyphenator)

Copyright (c) 2011 Andreas Heigl<andreas@heigl.org>
This library provides TeX-Hyphenation in PHP.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

+----------------------------------------------------------------------------+
| Requirements: |
+----------------------------------------------------------------------------+
# Requirements:

This package has the following requirements:

* PHP-Version >= 5.3
* Multibyte-Extension loaded
* Input has to be UTF8-encoded.

On loading the \Org\Heigl\Hyphenator\Hyphenator-class the internal encoding for
the Multibyte-String-Extension will be set to UTF8.

+----------------------------------------------------------------------------+
| Installation: |
+----------------------------------------------------------------------------+
# Installation:

There are three ways to install this package:

Expand All @@ -45,26 +24,46 @@ There are three ways to install this package:

More information can be found in the doc-section

+----------------------------------------------------------------------------+
| Usage: |
+----------------------------------------------------------------------------+
<?php
use \Org\Heigl\Hyphenator as h;
// Create a hyphenator-instance based on a given config-file
$hyphenator = h\Hyphenator::factory('/path/to/the/config/file.properties');
# Usage:

// And hyphenate a given string
$hyphenatedText = $hyphenator->hyphenate($string);
```php
<?php
use \Org\Heigl\Hyphenator as h;
// Create a hyphenator-instance based on a given config-file
$hyphenator = h\Hyphenator::factory('/path/to/the/config/file.properties');

// And hyphenate a given string
$hyphenatedText = $hyphenator->hyphenate($string);

echo $hyphenatedText;
?>
```

echo $hyphenatedText;
?>

+----------------------------------------------------------------------------+
| Documentation: |
+----------------------------------------------------------------------------+
# Documentation:

More documentation can be found at
http://orgheiglhyphenator.readthedocs.org/en/latest/
More documentation can be found at http://orgheiglhyphenator.readthedocs.org/en/latest/

Build-Status of the latest release can be found at http://travis-ci.org/#!/heiglandreas/Org_Heigl_Hyphenator

# Legal Stuff

Copyright (c) 2011-2013 Andreas Heigl<andreas@heigl.org>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Build-Status of the latest release can be found at
http://travis-ci.org/#!/heiglandreas/Org_Heigl_Hyphenator

0 comments on commit e3698a3

Please sign in to comment.