Skip to content

Commit 6626533

Browse files
committed
Re-organise README.md
1 parent caba37a commit 6626533

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PHP OpenStack SDK
22

33
[![Build Status](https://travis-ci.org/php-opencloud/openstack.svg?branch=master)](https://travis-ci.org/php-opencloud/openstack)
4-
![Coveralls github](https://img.shields.io/coveralls/github/php-opencloud/openstack/master.svg?style=flat)
4+
[![Coveralls github](https://img.shields.io/coveralls/github/php-opencloud/openstack/master.svg?style=flat-square)](https://coveralls.io/github/php-opencloud/openstack)
55
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/php-opencloud/openstack/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/php-opencloud/openstack/?branch=master)
66

77
`php-opencloud/openstack` is an SDK which allows PHP developers to easily connect to OpenStack APIs in a simple and
@@ -15,12 +15,11 @@ OpenStack services, and versions of services, are supported.
1515
* [Contributing guide](/CONTRIBUTING.md)
1616
* [Code of Conduct](/CODE_OF_CONDUCT.md)
1717

18-
## Backward incompatibility
18+
## Getting help
19+
20+
- Meet us on Slack: https://phpopencloud.slack.com ([Get your invitation](https://launchpass.com/phpopencloud))
21+
- Report and issue: https://github.com/php-opencloud/openstack/issues
1922

20-
Due to new [object typehint](https://wiki.php.net/rfc/object-typehint) since PHP 7.2, `Object` is a reserved keyword
21-
thus class `OpenStack\ObjectStore\v1\Models\Object` had to be renamed to
22-
`OpenStack\ObjectStore\v1\Models\StorageObject`. See [#184](https://github.com/php-opencloud/openstack/pull/184) for
23-
details.
2423

2524
### Version Guidance
2625

@@ -29,14 +28,18 @@ details.
2928
| `^2.0` | Maintained (Bug fixes only) | `>=7.0,<7.2` | March 2016 - March 2018 |
3029
| `^3.0` | Latest | `^7.0` | March 2018 - March 2020 |
3130

32-
## Getting help
33-
34-
- Meet us on Slack: https://phpopencloud.slack.com ([Get your invitation](https://launchpass.com/phpopencloud))
35-
- Report and issue: https://github.com/php-opencloud/openstack/issues
31+
## Upgrade from 2.x to 3.x
32+
33+
Due to new [object typehint](https://wiki.php.net/rfc/object-typehint) since PHP 7.2, `Object` is a reserved keyword
34+
thus class `OpenStack\ObjectStore\v1\Models\Object` had to be renamed to
35+
`OpenStack\ObjectStore\v1\Models\StorageObject`.
36+
37+
This change was introduced in [#184](https://github.com/php-opencloud/openstack/pull/184).
3638

3739
## Requirements
3840

3941
* PHP 7.0
42+
* `ext-curl`
4043

4144
## How to install
4245

@@ -51,4 +54,4 @@ taken the time to write a [contributing guide](CONTRIBUTING.md) for folks intere
5154
If you're not sure how you can get involved, feel free to
5255
[submit an issue](https://github.com/php-opencloud/openstack/issues/new) or
5356
[contact us](https://developer.rackspace.com/support/). You don't need to be a PHP expert - all members of the
54-
community are welcome!
57+
community are welcome!

0 commit comments

Comments
 (0)