Skip to content

Commit ec18cfe

Browse files
committed
ll
1 parent cb62fa5 commit ec18cfe

File tree

1 file changed

+4
-37
lines changed

1 file changed

+4
-37
lines changed

README.md

+4-37
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ This module is used by [PM2](https://github.com/Unitech/pm2) to communicate with
44

55
## Transporters
66

7-
Two transporters are available now, AxonTransporter and WebsocketTransporter.
8-
9-
AxonTransporter is using [axon pub-emitter](https://github.com/tj/axon) to send data (PushInteractor) to interaction server and [nssocket](https://github.com/foreverjs/nssocket) to receive data from reverse interaction server.
10-
117
WebsocketTransporter is using [websocket](https://github.com/websockets/ws) to send and receive data from websocket server.
128

139
## Launch
@@ -46,50 +42,21 @@ InteractorClient.launchAndInteract({}, {
4642

4743
## Configuration
4844

49-
To configure this agent you can use `config.json`.
45+
To configure this agent you can use `config.json`.
5046

5147
### Default
5248

53-
By default `AxonTransporter` is enabled and using `push` and `reverse` bucket's endpoint.
49+
By default `AxonTransporter` is enabled and using `push` and `reverse` bucket's endpoint.
5450
You can override this endpoints with `AGENT_PUSH_ENDPOINT` and `AGENT_REVERSE_ENDPOINT` environements' vars
5551

5652
By default `WebsocketTransporter` is disabled, you can enabled it with `AGENT_TRANSPORT_WEBSOCKET` environement's var, it's using `websocket` bucket's endpoint but you can override it with `AGENT_WEBSOCKET_ENDPOINT` environement's var.
5753

5854
### Transporters
5955

60-
Into this configuration you can put `transporter name` as key and for values, two keys are available `enabled` and `endpoints`.
56+
Into this configuration you can put `transporter name` as key and for values, two keys are available `enabled` and `endpoints`.
6157

6258
The `enabled` key is using to disable or enable transporter.
6359

64-
The `endpoints` key can be a string or an object. It depends on what the connect method of the transporter needs.
60+
The `endpoints` key can be a string or an object. It depends on what the connect method of the transporter needs.
6561
If you set a string, the connect method will be called with endpoint's value or raw value if no endpoint is matched.
6662
For objects, the connect method will be called with this object, and value of the keys will be replaced by endpoint's value or raw value if no endpoint is matched.
67-
68-
## Release
69-
70-
To release a new version, first install [gren](https://github.com/github-tools/github-release-notes) :
71-
```bash
72-
yarn global add github-release-notes
73-
```
74-
75-
Push a commit in github with the new version you want to release :
76-
```
77-
git commit -am "version: major|minor|patch bump to X.X.X"
78-
```
79-
80-
Care for the **versionning**, we use the [semver versioning](https://semver.org/) currently. Please be careful about the version when pushing a new package.
81-
82-
Then tag a version with git :
83-
```bash
84-
git tag -s vX.X.X
85-
```
86-
87-
Push the tag into github (this will trigger the publish to npm) :
88-
```
89-
git push origin vX.X.X
90-
```
91-
92-
To finish update the changelog of the release on github with `gren` (be sure that gren has selected the right tags):
93-
```
94-
gren release -o -D commits -u keymetrics -r pm2-io-agent
95-
```

0 commit comments

Comments
 (0)