Skip to content

Commit e0cdc4b

Browse files
committed
Rename project to nginx-plus-go-client
The new name is more appropriate then the previous nginx-plus-go-sdk. For upgrading, please add a new dependency - github.com/nginxinc/nginx-plus-go-client/client - to your project, remove the old github.com/nginxinc/nginx-plus-go-sdk/client and update the existing import paths accordingly.
1 parent abb5087 commit e0cdc4b

File tree

7 files changed

+15
-15
lines changed

7 files changed

+15
-15
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Steps to reproduce the behavior, such as:
1818
A clear and concise description of what you expected to happen.
1919

2020
**Your environment**
21-
* Version of nginx-plus-go-sdk
21+
* Version of nginx-plus-go-client
2222
* Version of NGINX Plus
2323
* Version of the OS
2424

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Describe the use case and detail of the change. If this PR addresses an issue on
44
### Checklist
55
Before creating a PR, run through this checklist and mark each as complete.
66

7-
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/nginx-plus-go-sdk/blob/master/CONTRIBUTING.md) doc
7+
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/nginx-plus-go-client/blob/master/CONTRIBUTING.md) doc
88
- [ ] I have added tests that prove my fix is effective or that my feature works
99
- [ ] I have checked that all unit tests pass after adding my changes
1010
- [ ] I have updated necessary documentation

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ language: go
22
go:
33
- "1.10"
44
script:
5-
- echo "N+ go SDK commit:${TRAVIS_COMMIT}"
5+
- echo "commit:${TRAVIS_COMMIT}"
66
jobs:
77
include:
88
- stage: Unit tests

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing Guidelines
22

3-
The following is a set of guidelines for contributing to the NGINX Plus Go SDK. We really appreciate that you are considering contributing!
3+
The following is a set of guidelines for contributing to the NGINX Plus Go Client. We really appreciate that you are considering contributing!
44

55
#### Table Of Contents
66

@@ -14,7 +14,7 @@ The following is a set of guidelines for contributing to the NGINX Plus Go SDK.
1414
* [Git Style Guide](#git-style-guide)
1515
* [Go Style Guide](#go-style-guide)
1616

17-
[Code of Conduct](https://github.com/nginxinc/nginx-plus-go-sdk/blob/master/CODE_OF_CONDUCT.md)
17+
[Code of Conduct](https://github.com/nginxinc/nginx-plus-go-client/blob/master/CODE_OF_CONDUCT.md)
1818

1919
## Ask a Question
2020

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11

2-
[![Build Status](https://travis-ci.org/nginxinc/nginx-plus-go-sdk.svg?branch=master)](https://travis-ci.org/nginxinc/nginx-plus-go-sdk) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Go Report Card](https://goreportcard.com/badge/github.com/nginxinc/nginx-plus-go-sdk)](https://goreportcard.com/report/github.com/nginxinc/nginx-plus-go-sdk)
2+
[![Build Status](https://travis-ci.org/nginxinc/nginx-plus-go-client.svg?branch=master)](https://travis-ci.org/nginxinc/nginx-plus-go-client) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Go Report Card](https://goreportcard.com/badge/github.com/nginxinc/nginx-plus-go-client)](https://goreportcard.com/report/github.com/nginxinc/nginx-plus-go-client)
33

4-
# NGINX Plus API Go SDK
4+
# NGINX Plus Go Client
55

6-
This SDK includes a client library for working with NGINX Plus API.
6+
This project includes a client library for working with NGINX Plus API.
77

8-
## About the SDK
8+
## About the Client
99

1010
`client/nginx.go` includes functions and data structures for working with NGINX Plus API as well as some helper functions.
1111

1212
## Compatibility
1313

14-
This SDK works against version 2 of NGINX Plus API. Version 2 was introduced in NGINX Plus R14.
14+
This Client works against version 2 of NGINX Plus API. Version 2 was introduced in NGINX Plus R14.
1515

16-
## Using the SDK
16+
## Using the Client
1717

18-
1. Import `github.com/nginxinc/nginx-plus-go-sdk/client` into your go project.
18+
1. Import `github.com/nginxinc/nginx-plus-go-client/client` into your go project.
1919
2. Use your favourite vendor tool to add this to your `/vendor` directory in your project.
2020

2121
## Testing
@@ -40,7 +40,7 @@ Run Tests:
4040
$ make test
4141
```
4242

43-
This will build and run an NGINX Plus container, execute the SDK tests against NGINX Plus API, and then clean up. If it fails and you want to clean up (i.e. stop the running container), please use `$ make clean`
43+
This will build and run an NGINX Plus container, execute the client tests against NGINX Plus API, and then clean up. If it fails and you want to clean up (i.e. stop the running container), please use `$ make clean`
4444

4545
## Support
4646
This project is not covered by the NGINX Plus support contract.

tests/client_no_stream_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"net/http"
55
"testing"
66

7-
"github.com/nginxinc/nginx-plus-go-sdk/client"
7+
"github.com/nginxinc/nginx-plus-go-client/client"
88
)
99

1010
// TestStatsNoStream tests the peculiar behavior of getting Stream-related

tests/client_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"testing"
88
"time"
99

10-
"github.com/nginxinc/nginx-plus-go-sdk/client"
10+
"github.com/nginxinc/nginx-plus-go-client/client"
1111
)
1212

1313
const (

0 commit comments

Comments
 (0)