Skip to content

Commit 44c1334

Browse files
Updates to README introduction
1 parent cac8228 commit 44c1334

File tree

1 file changed

+26
-56
lines changed

1 file changed

+26
-56
lines changed

README.md

Lines changed: 26 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@ PHP SDK for OpenStack/Rackspace APIs
44

55
[![Latest Stable Version](https://poser.pugx.org/rackspace/php-opencloud/v/stable.png)](https://packagist.org/packages/rackspace/php-opencloud) [![Travis CI](https://secure.travis-ci.org/rackspace/php-opencloud.png)](https://travis-ci.org/rackspace/php-opencloud) [![Total Downloads](https://poser.pugx.org/rackspace/php-opencloud/downloads.png)](https://packagist.org/packages/rackspace/php-opencloud)
66

7-
> **IMPORTANT NOTE**: With release 1.3, all of the file extensions have been
8-
changed from `.inc` to `.php`. This means that any existing code must be
9-
edited to use this new version.
10-
11-
> **ANOTHER IMPORTANT NOTE**: the working branch (soon to be release 1.5) has
12-
been substantially reorganized around namespaces and *all* of the file
13-
locations/names have been changed.
14-
157
See the
168
[COPYING](https://github.com/rackspace/php-opencloud/blob/master/COPYING)
179
file for license and copyright information.
@@ -26,67 +18,45 @@ so that you can still use the SDK with a pure OpenStack instance
2618
(for example, see the `OpenStack` class (for OpenStack) and the
2719
`Rackspace` subclass).
2820

29-
See the [Release Notes](https://github.com/rackspace/php-opencloud/releases)
30-
for what has changed in the latest release(s).
21+
Requirements
22+
------------
23+
* PHP >= 5.3.3
24+
* cURL extension for PHP
25+
26+
Installation
27+
------------
28+
You must install this library through Composer:
3129

32-
See the [php-opencloud wiki](https://github.com/rackspace/php-opencloud/wiki)
33-
for incidental notes mostly aimed at developers who are working *on* the
34-
SDK (and not developers working *with* the SDK).
30+
```
31+
# Install Composer
32+
curl -sS https://getcomposer.org/installer | php
3533
36-
Downloading
37-
-----------
34+
# Require php-opencloud as a dependency
35+
php composer.phar require rackspace/php-opencloud:dev-master
36+
```
3837

39-
Visit https://github.com/rackspace/php-opencloud/tags to see tagged releases
40-
that you can download.
38+
Once you have installed the library, you will need to load Composer's autoloader (which registers all the required
39+
namespaces):
4140

42-
You can download the master branch using the
43-
GitHub "ZIP" button, above. However, this has the latest code and may not
44-
be as stable as the tagged branches.
41+
```php
42+
require 'vendor/autoload.php';
43+
```
44+
45+
And you're ready to go!
4546

4647
Support and Feedback
4748
--------------------
48-
Your feedback is appreciated! If you have specific problems or bugs with the
49-
**php-opencloud**
50-
language bindings, please file an issue via Github.
49+
Your feedback is appreciated! If you have specific problems or bugs with this SDK, please file an issue on Github.
5150

52-
For general feedback and support requests, send an email to:
53-
54-
51+
For general feedback and support requests, send an email to [email protected].
5552

5653
You can also find assistance via IRC on #rackspace at freenode.net.
5754

58-
Getting Started with OpenStack/Rackspace
59-
----------------------------------------
60-
To sign up for a Rackspace Cloud account, go to
61-
http://www.rackspace.com/cloud and follow the prompts.
62-
63-
If you are working with an OpenStack deployment, you can find more
64-
information at http://www.openstack.org.
65-
66-
### Requirements
67-
68-
We are not able to test and validate every possible combination of PHP
69-
versions and supporting libraries, but here's our recommended minimum
70-
version list:
71-
72-
* PHP 5.3 (note: Travis validates against 5.4 and 5.5 as well)
73-
* CURL extensions to PHP
74-
75-
### Installation
76-
77-
In the .zip or .tar file in which you received the library, everything under
78-
the `lib/` directory should be installed in a location that is accessible. If you're not using a dependency manager like Composer, you will have to reference the php-opencloud file (which registers the library namespaces):
79-
80-
// Include the autoloader
81-
require_once '/path/to/lib/php-opencloud.php';
82-
83-
Once the OpenCloud namespace is registered, you will be able to access all functionality by referencing the class's namespace (in full PSR-0 compliance). For more information about namespaces, check out [PHP's documentation](http://php.net/manual/en/language.namespaces.php).
84-
8555
Contributing
8656
------------
87-
If you'd like to contribute to **php-opencloud**, see the
88-
[HACKING.md](https://github.com/rackspace/php-opencloud/blob/master/HACKING.md)
89-
file in the root directory.
57+
If you'd like to contribute, see the
58+
[Contributing guide](https://github.com/rackspace/php-opencloud/blob/master/CONTRIBUTING.md) and the
59+
[TODO list](https://github.com/rackspace/php-opencloud/blob/master/TODO.md).
9060

9161
Further Reading
9262
---------------

0 commit comments

Comments
 (0)