Skip to content

Commit

Permalink
Update doc path in README (#159)
Browse files Browse the repository at this point in the history
Co-authored-by: Voloshina Tatyana <voloshina@selectel.ru>
  • Loading branch information
T-Sh and Voloshina Tatyana committed Dec 15, 2022
1 parent 6943a1d commit 004a45b
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
@@ -1,5 +1,5 @@
# go-selvpcclient: a Go library for the Selectel VPC API
[![GoDoc](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient?status.svg)](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient)
[![GoDoc](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient?status.svg)](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient)
[![Go Report Card](https://goreportcard.com/badge/github.com/selectel/go-selvpcclient)](https://goreportcard.com/report/github.com/selectel/go-selvpcclient)
[![Build Status](https://travis-ci.org/selectel/go-selvpcclient.svg?branch=master)](https://travis-ci.org/selectel/go-selvpcclient)
[![Coverage Status](https://coveralls.io/repos/github/selectel/go-selvpcclient/badge.svg?branch=master)](https://coveralls.io/github/selectel/go-selvpcclient?branch=master)
Expand All @@ -8,7 +8,7 @@ Package go-selvpcclient provides a Go library to work with the Selectel VPC API.

## Documentation

The Go library documentation is available at [godoc.org](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient).
The Go library documentation is available at [godoc.org](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient).

The API usage examples are available at [knowledge base](https://kb.selectel.com/24381383.html).
API documentation is also available at the [VPC page](https://my.selectel.ru/vpc/docs) (if you've created an account on the [registration page](https://my.selectel.ru/registration)).
Expand All @@ -17,18 +17,18 @@ API documentation is also available at the [VPC page](https://my.selectel.ru/vpc

You can use this library to work with the following objects of the Selectel VPC API:

* [capabilities](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/capabilities)
* [floating ips](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/floatingips)
* [keypairs](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/keypairs)
* [licenses](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/licenses)
* [projects](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/projects)
* [quotas](https://godoc.org/github.com/selectel/go-selvpcclient/quotamanager/quotas)
* [roles](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/roles)
* [subnets](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/subnets)
* [tokens](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/tokens)
* [traffic](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/traffic)
* [users](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/users)
* [vrrp subnets](https://godoc.org/github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/vrrpsubnets)
* [capabilities](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/capabilities)
* [floating ips](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/floatingips)
* [keypairs](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/keypairs)
* [licenses](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/licenses)
* [projects](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/projects)
* [quotas](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/quotamanager/quotas)
* [roles](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/roles)
* [subnets](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/subnets)
* [tokens](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/tokens)
* [traffic](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/traffic)
* [users](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/users)
* [vrrp subnets](https://godoc.org/github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/vrrpsubnets)

Selectel VPC Cloud is based on the [OpenStack](https://www.openstack.org), so you don't need this library to work with actual servers, volumes, networks, etc.
You can use the [Gophercloud](https://github.com/gophercloud/gophercloud) project to work with the OpenStack objects.
Expand All @@ -40,7 +40,7 @@ You can use the [Gophercloud](https://github.com/gophercloud/gophercloud) projec
You can install `go-selvpcclient` as a Go package:

```bash
go get github.com/selectel/go-selvpcclient/selvpcclient
go get github.com/selectel/go-selvpcclient/selvpcclient/v2
```

### Authentication
Expand All @@ -60,8 +60,8 @@ import (
"fmt"
"log"

resell "github.com/selectel/go-selvpcclient/selvpcclient/resell/v2"
"github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/projects"
resell "github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2"
"github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/projects"
)

// API token from the https://my.selectel.ru.
Expand Down Expand Up @@ -93,11 +93,11 @@ import (
"fmt"
"log"

"github.com/selectel/go-selvpcclient/selvpcclient"
"github.com/selectel/go-selvpcclient/selvpcclient/quotamanager"
"github.com/selectel/go-selvpcclient/selvpcclient/quotamanager/quotas"
resell "github.com/selectel/go-selvpcclient/selvpcclient/resell/v2"
reselTokens "github.com/selectel/go-selvpcclient/selvpcclient/resell/v2/tokens"
"github.com/selectel/go-selvpcclient/v2/selvpcclient"
"github.com/selectel/go-selvpcclient/v2/selvpcclient/quotamanager"
"github.com/selectel/go-selvpcclient/v2/selvpcclient/quotamanager/quotas"
resell "github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2"
reselTokens "github.com/selectel/go-selvpcclient/v2/selvpcclient/resell/v2/tokens"
)

// token from the https://my.selectel.ru.
Expand Down

0 comments on commit 004a45b

Please sign in to comment.