Permalink
Browse files

Updaed package info.

  • Loading branch information...
1 parent 6a5a812 commit ba62708115340d42b395dffbf09d1941a34b358c @technosophos committed Feb 3, 2012
Showing with 54 additions and 8 deletions.
  1. +6 −0 API-2.0.0
  2. +35 −3 README.mdown
  3. +13 −5 package.xml
View
@@ -0,0 +1,6 @@
+LibRIS has been refactored to contain the following classes:
+
+- \LibRIS\RISReader: Read RIS files.
+- \LibRIS\RISWriter: Write RIS files.
+- \LibRIS\RISTags: Tags and labels for RIS files.
+- \LibRIS\ParseException: Thrown when parsing RIS fails.
View
@@ -13,7 +13,39 @@ reference for the format can be found here:
# Installation
-**Method 1:** Install LibRIS using Pear
+**Method 1:** Install using Packagist.
+
+1. Follow the instructions at http://packagist.org
+2. In your new project, create a `composer.json` file which requires
+ LibRIS:
+
+```javascript
+{
+ "require": {
+ "technosophos/LibRIS": ">=1.0.0"
+ }
+}
+```
+
+When you next run `php composer.phar install` it will automatically
+fetch and install LibRIS.
+
+Note that as of LibRIS 2.0.0, the Composer autoloader can load
+LibRIS:
+
+```php
+<?php
+require 'vendor/.composer/autoload.php';
+
+use \LibRIS\RISReader;
+
+$reader = new RISReader();
+
+//...
+?>
+```
+
+**Method 2:** Install LibRIS using Pear
Use your `pear` client to install LibRIS:
@@ -30,7 +62,7 @@ Use it in your scripts like this:
If you have already installed LibRIS using Pear, you can upgrade your library to the latest stable release by doing `pear upgrade LibRIS`.
-**Method 2:** Download LibRIS
+**Method 3:** Download LibRIS
1. Get LibRIS from [the downloads page](http://github.com/technosophos/LibRIS/downloads)
2. Uncompress the files (`tar -zxvf LibRIS-1.0.0.tgz`)
@@ -96,4 +128,4 @@ If you are interested in using this as part of a build toolchain, see [phing.inf
## Why is there a README file and a README.mdown file?
* README is a required file for the Pear packaging system.
-* README.mdown is the GitHub-friendly README file for this project.
+* README.mdown is the GitHub-friendly README file for this project.
View
@@ -13,15 +13,20 @@
<date>2011-01-07</date>
<time>10:14:32</time>
<version>
- <release>1.1.0</release>
- <api>1.1.0</api>
+ <release>2.0.0</release>
+ <api>2.0.0</api>
</version>
<stability>
<release>stable</release>
<api>stable</api>
</stability>
<license uri="http://www.opensource.org/licenses/bsd-license.php">New BSD License</license>
- <notes>1.1.0:
+ <notes>2.0.0
+Updated to use PHP namespaces, Packagist/Composer.
+
+Code was cleaned up, and better exception handling was added.
+
+1.1.0:
Updates for better EndNote export support.
@@ -48,7 +53,10 @@ New in 1.1.0: Regex expanded to cover EndNote cases.
<contents>
<dir name="/">
<dir name="src" baseinstalldir="/">
- <file role="php" name="LibRIS.php"/>
+ <file role="php" name="LibRIS/RISReader.php"/>
+ <file role="php" name="LibRIS/RISWriter.php"/>
+ <file role="php" name="LibRIS/RISTags.php"/>
+ <file role="php" name="LibRIS/ParseException.php"/>
</dir>
<dir name="tests" baseinstalldir="/">
<file role="test" name="Banyuls.ris"/>
@@ -62,7 +70,7 @@ New in 1.1.0: Regex expanded to cover EndNote cases.
<dependencies>
<required>
<php>
- <min>5.2.0</min>
+ <min>5.3.0</min>
</php>
<pearinstaller>
<min>2.0.0a1</min>

0 comments on commit ba62708

Please sign in to comment.