Skip to content

Commit 465f58e

Browse files
committed
Improve documentation
split users and devs docu
1 parent 15fa67b commit 465f58e

File tree

2 files changed

+6
-26
lines changed

2 files changed

+6
-26
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ $ docker container run -d -it -v $(pwd)/dockerfiles/conf/tomcat-users.xml:/usr/l
4444

4545
### Docker Compose (Tomcat + ngrok)
4646

47+
Additionally to the main NetLicensing Gateway instance, Docker Compose includes various helper tools needed for local testing and eCommerce connectors development:
48+
49+
- [Ngrok](https://ngrok.com) - expose local NetLicensing Gateway endpoints as public URLs, to allow eCommerce fulfilment webhook tests.
50+
4751
#### Start environment
4852

4953
```

README.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ After a successful transaction, all needed licensing configuration (Customers, L
1818
There are various ways available on how to enable NetLicensing Gateway in your licensing flow:
1919

2020
- Centrally hosted instance available at [gateway.netlicensing.io](https://gateway.netlicensing.io/monitoring)
21-
- Your individual instance from Docker image (check [Docker](#docker) and [Docker Compose](#docker-compose) instructions below)
21+
- Your individual instance from Docker image (check instructions below and in the [contributing instructions](CONTRIBUTING.md))
2222

2323
### Docker
2424

@@ -34,29 +34,6 @@ $ docker pull labs64/netlicensing-gateway
3434
$ docker container run -d -it --publish 8080:8080 --name netlicensing-gateway labs64/netlicensing-gateway
3535
```
3636

37-
### Docker Compose
38-
39-
Additionally to the main NetLicensing Gateway instance, Docker Compose includes various helper tools needed for local testing and eCommerce connectors development:
40-
41-
- [Ngrok](https://ngrok.com) - expose local NetLicensing Gateway endpoints as public URLs, to allow eCommerce fulfilment webhook tests.
42-
43-
#### Clone repository
44-
45-
```
46-
$ git clone https://github.com/Labs64/NetLicensing-Gateway.git
47-
```
48-
49-
#### Start containers
50-
```
51-
$ docker-compose up -d
52-
```
53-
54-
#### Stop containers
55-
56-
```
57-
$ docker-compose down
58-
```
59-
6037
### Test configuration
6138

6239
#### Sanity check
@@ -69,7 +46,7 @@ Refer to the eCommerce connectors [setup and configuration guides](https://netli
6946

7047
## Contributors
7148

72-
New connectors' integrations as community implementation are highly appreciated and welcome.
49+
New integrations (eCommerce connectors) as community implementation are highly appreciated and welcome.
7350
Please refer to the [contributing instructions](CONTRIBUTING.md).
7451

7552
## Bugs and Feedback
@@ -82,7 +59,6 @@ NetLicensing Gateway is open-source software licensed under the [Apache 2.0](LIC
8259

8360
## Links
8461

85-
- [Labs64 @ Docker Hub](https://hub.docker.com/u/labs64)
8662
- NetLicensing Gateway [Docker image](https://hub.docker.com/r/labs64/netlicensing-gateway)
8763
- NetLicensing [Integrations](https://netlicensing.io/wiki/integrations)
8864
- NetLicensing [RESTful API](https://netlicensing.io/wiki/restful-api)

0 commit comments

Comments
 (0)