Merge pull request #9 from seblucas/master

Allow downloading an updated epub without saving it in a temporary directory

Author: splitbrain

.gitignore

@@ -0,0 +1,6 @@
+/coverage/*
+/vendor/*
+/php-epub-meta.sublime-*
+/clover.xml
+/composer.phar
+

.hgtags

@@ -0,0 +1 @@
+c5bdb12b19a22820b16b9f252b12e756f1ac8505 1.0.0

.travis.yml

@@ -0,0 +1,18 @@
+language: php
+php:
+  - 7.0
+  - 5.6
+  - 5.5
+  - hhvm
+before_script:
+  - composer selfupdate
+  - composer install
+script:
+  - phpunit
+after_success:
+  - chmod +x test/publishCoverage.sh
+  - test/publishCoverage.sh
+matrix:
+  allow_failures:
+    - php: hhvm
+    - php: 5.5

LICENSE

@@ -1,3 +1,5 @@
+MIT License
+
 Copyright (c) 2012 Andreas Gohr <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of

README renamed to README.md

@@ -1,4 +1,5 @@
-====== PHP EPub Meta ======
+PHP EPub Meta
+=============
 
 This project aims to create a PHP class for reading and writing metadata
 included in the EPub ebook format.
@@ -9,20 +10,35 @@ Please see the issue tracker for what's missing.
 
 Forks and pull requests welcome.
 
-===== About the EPub Manager Web Interface =====
+
+About the EPub Manager Web Interface
+------------------------------------
 
 The manager expects your ebooks in a single flat directory (no subfolders). The
 location of that directory has to be configured at the top of the index.php file.
 
 All the epubs need to be read- and writable by the webserver.
 
 The manager also makes some assumption on how the files should be named. The
-format is: "<Author file-as>-<Title>.epub". Commas will be replaced by __ and
-spaces are replaced by _.
+format is: `<Author file-as>-<Title>.epub`. Commas will be replaced by `__` and
+spaces are replaced by `_`.
 
-Note that the manager will RENAME your files to that form when saving.
+Note that the manager will **RENAME** your files to that form when saving.
 
 Using the "Lookup Book Data" link will open a dialog that searches the book at
 Google Books you can use the found data using the "fill in" and "replace"
 buttons. The former will only fill empty fields, while the latter will replace
 all data. Author filling is missing currently.
+
+
+Installing via Composer
+=======================
+
+You can use this package in your projects with [Composer](https://getcomposer.org/). Just
+add these lines to your project's `composer.json`:
+
+```
+    "require": {
+        "seblucas/php-epub-meta": "dev-master",
+    }
+```

composer.json

@@ -0,0 +1,33 @@
+{
+    "name": "seblucas/php-epub-meta",
+    "type": "library",
+    "description": "Reading and writing metadata included in the EPub ebook format",
+    "keywords": ["epub", "metadata", "ebook"],
+    "homepage": "https://github.com/seblucas/php-epub-meta",
+    "authors": [
+        {
+            "name": "Andreas Gohr",
+            "email": "[email protected]",
+            "homepage": "https://www.splitbrain.org/",
+            "role": "Developer"
+        },
+        {
+            "name": "Sébastien Lucas",
+            "email": "[email protected]",
+            "homepage": "http://www.slucas.fr/",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=5.3.0",
+        "ext-xml": "*",
+        "ext-zip": "*",
+        "seblucas/tbszip": "~2.16.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "4.*"
+    },
+    "autoload": {
+        "classmap": ["lib/"]
+    }
+}