diff --git a/README.md b/README.md index fdfadd8..ba4cf28 100644 --- a/README.md +++ b/README.md @@ -17,20 +17,7 @@ Installation Use `go get git.openstack.org/stackforge/golang-client.git`. Or alternatively, download or clone the repository. -The lib was developed and tested on go 1.0.3 and 1.1.1, but maintenance has moved -to 1.1.1 only. No external dependencies, so far. - -Usage ------ -The `*_integration_test.go` files show usage examples for using the lib to connect -to live OpenStack service. The documentation follows golang documentation -convention: `go doc`. Here is a short example code snippet: - - auth, err := identity.AuthUserNameTenantId(identityHost, - userName, password, tenantId) - ... - httpHdr, err := objectstorage.GetAccountMeta(objectstorageHost, - auth.Access.Token.Id) +The lib was developed and tested on go 1.2. No external dependencies, so far. Examples -------- @@ -44,22 +31,13 @@ executed running the script `run-all.sh` from the examples directory. Testing ------- There are two types of test files. The `*_test.go` are standard -golang unit test files. The `*_integration_test.go` are -test files that require an active OpenStack service account before -you can properly test. If you do not have an account, -then running `go test` on the `*_integration_test.go` files will fail. - -If you already have an account, please read -`identity/identitytest/setupUser.go` on how to set up the JSON data file so -you can authenticate to the OpenStack service. If you do not have an account, -please change the file extension to something that golang compiler will -ignore to avoid fails. +golang unit test files. The examples can be run as integration tests. The tests were written against the [OpenStack API specifications] (http://docs.openstack.org/api/api-specs.html). The integration test were successful against the following: -- [HP Cloud](http://docs.hpcloud.com/api/) +- [HP Helion Public Cloud](http://docs.hpcloud.com/api/) If you use another provider and successfully completed the tests, please email the maintainer(s) so your service can be mentioned here. Alternatively, if you @@ -79,10 +57,6 @@ please consider joining as an [OpenStack contributor] (https://wiki.openstack.org/wiki/HowToContribute). If you have questions or comments, you can email the maintainer(s). -Maintainer ----------- -Slamet Hendry (slamet dot hendry at gmail dot com) - Coding Style ------------ The source code is automatically formatted to follow `go fmt` by the [IDE]