From 6bd649c88758cb078458cf1311b185fa7a516bf7 Mon Sep 17 00:00:00 2001 From: Ryan McCue Date: Wed, 8 Feb 2012 13:45:14 +1000 Subject: [PATCH] Style the README's text a little better with wrapping --- README.md | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b43e721c4..919e2d418 100755 --- a/README.md +++ b/README.md @@ -52,38 +52,48 @@ Installation ------------ ### Install with Composer -If you're using [Composer](https://github.com/composer/composer) to manage dependencies, you can add Requests with it. +If you're using [Composer](https://github.com/composer/composer) to manage +dependencies, you can add Requests with it. - { - "require": { - "rmccue/requests": ">=1.0" - } - } + { + "require": { + "rmccue/requests": ">=1.0" + } + } ### Install source from GitHub To install the source code: - git clone git://github.com/rmccue/Requests.git + $ git clone git://github.com/rmccue/Requests.git And include it in your scripts: - require_once '/path/to/Requests/library/Requests.php'; + require_once '/path/to/Requests/library/Requests.php'; You'll probably also want to register an autoloader: Requests::register_autoloader(); + ### Install source from zip/tarball -Alternatively, you can fetch a [tarball](https://github.com/rmccue/Requests/tarball/master) or [zipball](https://github.com/rmccue/Requests/zipball/master): +Alternatively, you can fetch a [tarball][] or [zipball][]: $ curl https://github.com/rmccue/Requests/tarball/master | tar xzv (or) $ wget https://github.com/rmccue/Requests/tarball/master -O - | tar xzv +[tarball]: https://github.com/rmccue/Requests/tarball/master +[zipball]: https://github.com/rmccue/Requests/zipball/master + + ### Using a Class Loader -If you're using a class loader (e.g., [Symfony Class Loader](https://github.com/symfony/ClassLoader)) for [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md)-style class loading: +If you're using a class loader (e.g., [Symfony Class Loader][]) for +[PSR-0][]-style class loading: + + $loader->registerNamespace('Requests', 'path/to/vendor/Requests/library'); - $loader->registerNamespace('Requests', 'path/to/vendor/Requests/library'); +[Symfony Class Loader]: https://github.com/symfony/ClassLoader +[PSR-0]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md Documentation