Skip to content

Commit 1e13d50

Browse files
committed
Add compatibility note. Fix formatting
1 parent 7e6dd80 commit 1e13d50

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ We will have a public forum soon where you can come and ask questions and have a
2323

2424
## Getting Started
2525

26-
Read the usage and testing steps in the [README](https://github.com/nginxinc/nginx-plus-go-sdk/blob/master/README.md).
26+
Read the usage and testing steps in the [README](README.md).
2727

2828

2929
## Contributing
@@ -39,7 +39,7 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha
3939
### Open a Pull Request
4040

4141
* Fork the repo, create a branch, submit a PR when your changes are tested and ready for review
42-
* You will be asked to fill in [our pull request template](https://github.com/nginxinc/nginx-plus-go-sdk/blob/master/.github/PULL_REQUEST_TEMPLATE.md)
42+
* You will be asked to fill in [our pull request template](.github/PULL_REQUEST_TEMPLATE.md)
4343

4444
Note: if you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
4545

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ file or class name and description of purpose be included on the
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright 2016 Nginx, Inc.
189+
Copyright 2018 Nginx, Inc.
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ This SDK includes a client library for working with NGINX Plus API.
66

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

9+
## Compatibility
10+
11+
This SDK works against version 2 of NGINX Plus API. Version 2 was introduced in NGINX Plus R14.
12+
913
## Using the SDK
1014

1115
1. Import `github.com/nginxinc/nginx-plus-go-sdk/client` into your go project.
@@ -36,4 +40,4 @@ $ make test
3640
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`
3741

3842
## Support
39-
This project is not covered by the NGINX Plus support contract
43+
This project is not covered by the NGINX Plus support contract.

0 commit comments

Comments
 (0)