2017-06-26 05:45:22 +08:00
# QingStor SDK for Go
[](https://travis-ci.org/yunify/qingstor-sdk-go)
[](https://goreportcard.com/report/github.com/yunify/qingstor-sdk-go)
[](http://docs.qingcloud.com/qingstor/)
[](https://github.com/yunify/qingstor-sdk-go/blob/master/LICENSE)
2019-11-11 15:04:53 +00:00
English | [中文 ](README_zh-CN.md )
2017-06-26 05:45:22 +08:00
2019-11-11 15:04:53 +00:00
The official QingStor SDK for the Go programming language.
2017-06-26 05:45:22 +08:00
2019-11-11 15:04:53 +00:00
Before you start using the SDK, make sure you have a basic understanding of the concepts of [QingStor object storage ](https://docs.qingcloud.com/qingstor/api/common/overview.html ) (such as Zone, Service, Bucket, Object, etc.).
2017-06-26 05:45:22 +08:00
2019-11-11 15:04:53 +00:00
This SDK try to keep a one-to-one correspondence with the methods on the [QingCloud QingStor object storage documentation ](https://docs.qingcloud.com/qingstor/api/ ). For details of each method, please refer to the corresponding chapter in the link.
2017-06-26 05:45:22 +08:00
2019-11-11 15:04:53 +00:00
## Quick Start
2017-06-26 05:45:22 +08:00
2019-11-11 15:04:53 +00:00
Now you are ready to code. You can read the detailed guides in the list below to have a clear understanding.
2017-06-26 05:45:22 +08:00
2019-11-11 15:04:53 +00:00
- [Preparation ](./docs/prepare.md )
- [Installation ](./docs/install.md )
- [Configuration ](./docs/config.md )
- [Service Initialization ](./docs/service.md )
- [Code Examples ](./docs/examples.md )
2017-06-26 05:45:22 +08:00
2019-11-11 15:04:53 +00:00
Checkout our [releases ](https://github.com/yunify/qingstor-sdk-go/releases ) and [change log ](./CHANGELOG.md ) for information about the latest features, bug fixes and new ideas.
2017-06-26 05:45:22 +08:00
## Reference Documentations
- [QingStor Documentation ](https://docs.qingcloud.com/qingstor/index.html )
- [QingStor Guide ](https://docs.qingcloud.com/qingstor/guide/index.html )
- [QingStor APIs ](https://docs.qingcloud.com/qingstor/api/index.html )
## Contributing
1. Fork it ( https://github.com/yunify/qingstor-sdk-go/fork )
2. Create your feature branch (`git checkout -b new-feature` )
3. Commit your changes (`git commit -asm 'Add some feature'` )
4. Push to the branch (`git push origin new-feature` )
5. Create a new Pull Request
## LICENSE
The Apache License (Version 2.0, January 2004).
