Renaming SDK to API client

Author: jgabor

README.md

@@ -1,30 +1,30 @@
-# UpCloud Go SDK
+# UpCloud Go API client library
 
-[![Build Status](https://travis-ci.org/UpCloudLtd/upcloud-go-sdk.svg?branch=master)](https://travis-ci.org/UpCloudLtd/upcloud-go-sdk)
-[![Go Report Card](https://goreportcard.com/badge/github.com/UpCloudLtd/upcloud-go-sdk)](https://goreportcard.com/report/github.com/UpCloudLtd/upcloud-go-sdk)
-[![GoDoc](https://godoc.org/github.com/UpCloudLtd/upcloud-go-sdk?status.svg)](https://godoc.org/github.com/UpCloudLtd/upcloud-go-sdk)
+[![Build Status](https://travis-ci.org/UpCloudLtd/upcloud-go-api.svg?branch=master)](https://travis-ci.org/UpCloudLtd/upcloud-go-api)
+[![Go Report Card](https://goreportcard.com/badge/github.com/UpCloudLtd/upcloud-go-api)](https://goreportcard.com/report/github.com/UpCloudLtd/upcloud-go-api)
+[![GoDoc](https://godoc.org/github.com/UpCloudLtd/upcloud-go-api?status.svg)](https://godoc.org/github.com/UpCloudLtd/upcloud-go-api)
 
-This is the SDK for interfacing with UpCloud's API using the Go programming language. The features in the development kit allow easy application creation and simplify UpCloud API integration when using Go.
+This is the official client for interfacing with UpCloud's API using the Go programming language. The features allows for easy and quick development and integration when using Go.
 
 ## Installation and requirements
 
-You'll need Go 1.7 or higher to use the SDK. You can use the following command to retrieve the SDK:
+You'll need Go 1.7 or higher to use the client. You can use the following command to retrieve the client:
 
 ```
-go get github.com/UpCloudLtd/upcloud-go-sdk
+go get github.com/UpCloudLtd/upcloud-go-api
 ```
 
 ## Usage
 
-The general usage of the SDK adheres to the following pattern:
+The general usage of the client adheres to the following pattern:
 
 * Authenticate by creating a `client.Client`
 * Create a `service.Service` by passing the newly created `client` object to it
 * Interface with the API using the various methods of the `service` object. Methods that take parameters wrap them in request objects.
 
 We recommend setting up a separate subaccount for API usage to allow better access control and security. You can find out more about creating subaccounts at the following support article for [Server Tags and Group Accounts](https://www.upcloud.com/support/server-tags-and-group-accounts/). We strongly recommend limiting the connections to a specific address or address range for security purposes.
 
-The examples here only deal with how to use the SDK itself. For information on how to use the API in general, please consult the [UpCloud API documentation](https://www.upcloud.com/api/).
+The examples here only deal with how to use the client itself. For information on how to use the API in general, please consult the [UpCloud API documentation](https://www.upcloud.com/api/).
 
 ### Creating the client and the service
 
@@ -52,7 +52,7 @@ svc := service.New(client.New(username, password))
 _, err := svc.GetAccount()
 
 if err != nil {
-	panic("Invalid credentials")
+    panic("Invalid credentials")
 }
 ```
 
@@ -70,11 +70,11 @@ _, err := svc.GetAccount()
 
 // Handle errors in general
 if (err != nil) {
-	// Handle service errors specifically
-	if serviceError, ok := err.(*upcloud.Error); ok {
-		fmt.Println(serviceError.ErrorCode)
-		fmt.Println(serviceError.ErrorMessage)
-	}
+    // Handle service errors specifically
+    if serviceError, ok := err.(*upcloud.Error); ok {
+        fmt.Println(serviceError.ErrorCode)
+        fmt.Println(serviceError.ErrorMessage)
+    }
 }
 ````
 
@@ -96,12 +96,12 @@ The following example will retrieve a list of servers the account has access to.
 servers, err := svc.GetServers()
 
 if err != nil {
-	panic(err)
+    panic(err)
 }
 
 // Print the UUID and hostname of each server
 for _, server := range servers.Servers {
-	fmt.Println(fmt.Sprintf("UUID: %s, hostname: %s", server.UUID, server.Hostname))
+    fmt.Println(fmt.Sprintf("UUID: %s, hostname: %s", server.UUID, server.Hostname))
 }
 ```
 
@@ -112,50 +112,50 @@ Since the request for creating a new server is asynchronous, the server will rep
 ```go
 // Create the server
 serverDetails, err := svc.CreateServer(&request.CreateServerRequest{
-	Zone:             "fi-hel1",
-	Title:            "My new server",
-	Hostname:         "server.example.com",
-	PasswordDelivery: request.PasswordDeliveryNone,
-	StorageDevices: []request.CreateServerStorageDevice{
-		{
-			Action:  request.CreateStorageDeviceActionClone,
-			Storage: "01000000-0000-4000-8000-000030060200",
-			Title:   "disk1",
-			Size:    30,
-			Tier:    upcloud.StorageTierMaxIOPS,
-		},
-	},
-	IPAddresses: []request.CreateServerIPAddress{
-		{
-			Access: upcloud.IPAddressAccessPrivate,
-			Family: upcloud.IPAddressFamilyIPv4,
-		},
-		{
-			Access: upcloud.IPAddressAccessPublic,
-			Family: upcloud.IPAddressFamilyIPv4,
-		},
-		{
-			Access: upcloud.IPAddressAccessPublic,
-			Family: upcloud.IPAddressFamilyIPv6,
-		},
-	},
+    Zone:             "fi-hel1",
+    Title:            "My new server",
+    Hostname:         "server.example.com",
+    PasswordDelivery: request.PasswordDeliveryNone,
+    StorageDevices: []request.CreateServerStorageDevice{
+        {
+            Action:  request.CreateStorageDeviceActionClone,
+            Storage: "01000000-0000-4000-8000-000030060200",
+            Title:   "disk1",
+            Size:    30,
+            Tier:    upcloud.StorageTierMaxIOPS,
+        },
+    },
+    IPAddresses: []request.CreateServerIPAddress{
+        {
+            Access: upcloud.IPAddressAccessPrivate,
+            Family: upcloud.IPAddressFamilyIPv4,
+        },
+        {
+            Access: upcloud.IPAddressAccessPublic,
+            Family: upcloud.IPAddressFamilyIPv4,
+        },
+        {
+            Access: upcloud.IPAddressAccessPublic,
+            Family: upcloud.IPAddressFamilyIPv6,
+        },
+    },
 })
 
 if err != nil {
-	panic(err)
+    panic(err)
 }
 
 fmt.Println(fmt.Sprintf("Server %s with UUID %s created", serverDetails.Title, serverDetails.UUID))
 
 // Block for up to five minutes until the server has entered the "started" state
 err = svc.WaitForServerState(&request.WaitForServerStateRequest{
-	UUID:         serverDetails.UUID,
-	DesiredState: upcloud.ServerStateStarted,
-	Timeout:      time.Minute * 5,
+    UUID:         serverDetails.UUID,
+    DesiredState: upcloud.ServerStateStarted,
+    Timeout:      time.Minute * 5,
 })
 
 if err != nil {
-	panic(err)
+    panic(err)
 }
 
 fmt.Println("Server is now started")
@@ -168,21 +168,21 @@ In this example, we assume that there is a server represented by the variable `s
 ```go
 // Loop through the storage devices
 for i, storage := range serverDetails.StorageDevices {
-	// Find the first device
-	if i == 0 {
-		// Templatize the storage
-		storageDetails, err := svc.TemplatizeStorage(&request.TemplatizeStorageRequest{
-			UUID:  storage.UUID,
-			Title: "Templatized storage",
-		})
-
-		if err != nil {
-			panic(err)
-		}
-		
-		fmt.Println(fmt.Sprintf("Storage templatized as %s", storageDetails.UUID))		
-		break
-	}
+    // Find the first device
+    if i == 0 {
+        // Templatize the storage
+        storageDetails, err := svc.TemplatizeStorage(&request.TemplatizeStorageRequest{
+            UUID:  storage.UUID,
+            Title: "Templatized storage",
+        })
+
+        if err != nil {
+            panic(err)
+        }
+        
+        fmt.Println(fmt.Sprintf("Storage templatized as %s", storageDetails.UUID))      
+        break
+    }
 }
 ```
 
@@ -192,8 +192,8 @@ In this example, we assume that there is a storage device represented by `storag
 
 ```go
 backupDetails, err := svc.CreateBackup(&request.CreateBackupRequest{
-	UUID:  storageDetails.UUID,
-	Title: "Backup",
+    UUID:  storageDetails.UUID,
+    Title: "Backup",
 })
 
 if err != nil {
@@ -209,15 +209,15 @@ In this example, we assume that there is a server represented by the variable `s
 
 ```go
 firewallRule, err := svc.CreateFirewallRule(&request.CreateFirewallRuleRequest{
-	ServerUUID: serverDetails.UUID,
-	FirewallRule: upcloud.FirewallRule{
-		Direction: upcloud.FirewallRuleDirectionIn,
-		Action:    upcloud.FirewallRuleActionAccept,
-		Family:    upcloud.IPAddressFamilyIPv4,
-		Protocol:  upcloud.FirewallRuleProtocolTCP,
-		Position:  1,
-		Comment:   "Accept all TCP input on IPv4",
-	},
+    ServerUUID: serverDetails.UUID,
+    FirewallRule: upcloud.FirewallRule{
+        Direction: upcloud.FirewallRuleDirectionIn,
+        Action:    upcloud.FirewallRuleActionAccept,
+        Family:    upcloud.IPAddressFamilyIPv4,
+        Protocol:  upcloud.FirewallRuleProtocolTCP,
+        Position:  1,
+        Comment:   "Accept all TCP input on IPv4",
+    },
 })
 
 if err != nil {
@@ -242,16 +242,16 @@ it returns. Import the collection into Postman, then create an environment conta
 To be able to run the test suite you'll need to export the following environment variables with their corresponding 
 values:
 
-* `UPCLOUD_GO_SDK_TEST_USER` (the API username)
-* `UPCLOUD_GO_SDK_TEST_PASSWORD` (the API password)
-* `UPCLOUD_GO_SDK_TEST_DELETE_RESOURCES` (either `yes` or `no`)
+* `UPCLOUD_GO_API_TEST_USER` (the API username)
+* `UPCLOUD_GO_API_TEST_PASSWORD` (the API password)
+* `UPCLOUD_GO_API_TEST_DELETE_RESOURCES` (either `yes` or `no`)
 
-To run the test suite, run `go test ./... -v -parallel 8`. If `UPCLOUD_GO_SDK_TEST_DELETE_RESOURCES` is set to `yes`, 
+To run the test suite, run `go test ./... -v -parallel 8`. If `UPCLOUD_GO_API_TEST_DELETE_RESOURCES` is set to `yes`, 
 all resources will be stopped and/or deleted after the test suite has run. Be careful which account you use for 
 testing so you don't accidentally delete or your production resources!
 
 You can skip running the integration tests and just run the unit tests by passing `-short` to the test command.
 
 ## License
 
-This SDK is distributed under the [MIT License](https://opensource.org/licenses/MIT), see LICENSE.txt for more information.
+This client is distributed under the [MIT License](https://opensource.org/licenses/MIT), see LICENSE.txt for more information.