# QingCloud SDK for Go

[![Build Status](https://travis-ci.org/yunify/qingcloud-sdk-go.svg?branch=master)](https://travis-ci.org/yunify/qingcloud-sdk-go)
[![Go Report Card](https://goreportcard.com/badge/github.com/yunify/qingcloud-sdk-go)](https://goreportcard.com/report/github.com/yunify/qingcloud-sdk-go)
[![API Reference](http://img.shields.io/badge/api-reference-green.svg)](http://docs.qingcloud.com)
[![License](http://img.shields.io/badge/license-apache%20v2-blue.svg)](https://github.com/yunify/qingcloud-sdk-go/blob/master/LICENSE)

The official QingCloud SDK for the Go programming language.

## Getting Started

### Installation

Refer to the [Installation Guide](docs/installation.md), and have this SDK installed.

### Preparation

Before your start, please go to [QingCloud Console](https://console.qingcloud.com/access_keys/) to create a pair of QingCloud API AccessKey.

___API AccessKey Example:___

``` yaml
qy_access_key_id: 'ACCESS_KEY_ID_EXAMPLE'
qy_secret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE'
```

### Usage

Now you are ready to code. You can read the detailed guides in the list below to have a clear understanding.

- [Configuration Guide](docs/configuration.md)
- [QingCloud Service Usage Guide](docs/qingcloud_service_usage.md)

Checkout our [releases](https://github.com/yunify/qingcloud-sdk-go/releases) and [change logs](https://github.com/yunify/qingcloud-sdk-go/blob/master/CHANGELOG.md) for information about the latest features, bug fixes and new ideas.

## Reference Documentations

- [QingCloud Documentation Overview](https://docs.qingcloud.com)
- [QingCloud APIs](https://docs.qingcloud.com/api/index.html)

## Contributing

1. Fork it ( https://github.com/yunify/qingcloud-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).