Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mlocati committed May 4, 2016
1 parent 25b1b26 commit 8427235
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
@@ -0,0 +1,21 @@
[![Build Status](https://api.travis-ci.org/mlocati/chm-lib.svg?branch=master)](https://travis-ci.org/mlocati/chm-lib)
[![HHVM Status](http://hhvm.h4cc.de/badge/mlocati/chm-lib.svg?style=flat)](http://hhvm.h4cc.de/package/mlocati/chm-lib)
[![StyleCI Status](https://styleci.io/repos/58052834/shield)](https://styleci.io/repos/58052834)
[![Coverage Status](https://coveralls.io/repos/github/mlocati/chm-lib/badge.svg?branch=master)](https://coveralls.io/github/mlocati/chm-lib?branch=master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mlocati/chm-lib/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mlocati/chm-lib/?branch=master)

# CHMLib - Read CHM (Microsoft Compiled HTML Help) files from PHP


## Sample usage


```php
require_once 'CHMLib.php'; // You don't have this if you use Composer

$chm = \CHMLib\CHM::fromFile('YourFile.chm');
foreach ($chm->getEntries(\CHMLib\Entry::TYPE_FILE) as $entry) {
echo "File: ", $entry->getPath(), "\n";
echo "Contents: ", $entry->getContents(), "\n\n";
}
```

0 comments on commit 8427235

Please sign in to comment.