Skip to content
Browse files

Update documentation

  • Loading branch information...
1 parent 66a29f0 commit 99d9778a1f091f08b0e7e37d4fe33d841b2314dc @sebastianbergmann committed Aug 3, 2013
Showing with 23 additions and 24 deletions.
  1. +0 −23 README.markdown
  2. +22 −0 README.md
  3. +1 −1 package.xml
View
23 README.markdown
@@ -1,23 +0,0 @@
-PHP_TokenStream
-===============
-
-Installation
-------------
-
-PHP_TokenStream should be installed using the [PEAR Installer](http://pear.php.net/). This installer is the backbone of PEAR, which provides a distribution system for PHP packages, and is shipped with every release of PHP since version 4.3.0.
-
-The PEAR channel (`pear.phpunit.de`) that is used to distribute PHP_TokenStream needs to be registered with the local PEAR environment:
-
- sb@ubuntu ~ % pear channel-discover pear.phpunit.de
- Adding Channel "pear.phpunit.de" succeeded
- Discovery of channel "pear.phpunit.de" succeeded
-
-This has to be done only once. Now the PEAR Installer can be used to install packages from the PHPUnit channel:
-
- sb@ubuntu tokenstream % pear install phpunit/PHP_TokenStream-beta
- downloading PHP_TokenStream-0.9.1.tgz ...
- Starting to download PHP_TokenStream-0.9.1.tgz (5,113 bytes)
- ...done: 5,113 bytes
- install ok: channel://pear.phpunit.de/PHP_TokenStream-0.9.1
-
-After the installation you can find the PHP_TokenStream source files inside your local PEAR directory; the path is usually `/usr/lib/php/PHP`.
View
22 README.md
@@ -0,0 +1,22 @@
+# PHP_TokenStream
+
+## Installation
+
+You can use [Composer](http://getcomposer.org/) or the [PEAR Installer](http://pear.php.net/manual/en/guide.users.commandline.cli.php) to download and install this package as well as its dependencies.
+
+### Composer
+
+To add this package as a local, per-project dependency to your project, simply add a dependency on `phpunit/php-token-stream` to your project's `composer.json` file. Here is a minimal example of a `composer.json` file that just defines a dependency on PHP_TokenStream:
+
+ {
+ "require": {
+ "phpunit/php-token-stream": "*"
+ }
+ }
+
+### PEAR Installer
+
+The following two commands (which you may have to run as `root`) are all that is required to install this package using the PEAR Installer:
+
+ pear config-set auto_discover 1
+ pear install pear.phpunit.de/PHP_TokenStream
View
2 package.xml
@@ -50,7 +50,7 @@
</dir>
<file baseinstalldir="/" name="ChangeLog.markdown" role="doc"/>
<file baseinstalldir="/" name="LICENSE" role="doc"/>
- <file baseinstalldir="/" name="README.markdown" role="doc"/>
+ <file baseinstalldir="/" name="README.md" role="doc"/>
</dir>
</contents>
<dependencies>

0 comments on commit 99d9778

Please sign in to comment.
Something went wrong with that request. Please try again.