Skip to content

Commit d90bfd3

Browse files
committed
Add README
1 parent 1657018 commit d90bfd3

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# NGINX Plus Golang SDK
2+
3+
This SDK includes a client library for working with NGINX Plus API.
4+
5+
## About the SDK
6+
7+
`client/nginx_client.go` includes functions and data structures for working with NGINX Plus API as well as some helper functions.
8+
9+
## Using the SDK
10+
11+
For now, copy `client/nginx_client.go` into your go project.
12+
13+
## Testing
14+
15+
Prerequisites:
16+
* Docker
17+
* golang
18+
* Make
19+
* NGINX Plus license -- put `nginx-repo.crt` and `nginx-repo.key` into the `docker` folder.
20+
21+
Steps:
22+
1. Build an NGINX Plus Image:
23+
```
24+
$ make docker-build
25+
```
26+
1. Run an NGINX Plus container:
27+
```
28+
$ make run-nginx-plus
29+
```
30+
1. Make sure `GOPATH` is configured properly.
31+
1. Run both unit and e2e tests:
32+
```
33+
$ make test
34+
```
35+
36+
37+

0 commit comments

Comments
 (0)