Skip to content

Commit 940048d

Browse files
author
Jannis Pohlmann
committed
README: Add notes about testing and logging
1 parent 2d7c97b commit 940048d

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,13 @@ Implementation of the [GraphQL over WebSocket protocol] in Go.
2020
cd "$GOPATH/github.com/functionalfoundry"
2121
git clone https://github.com/functionalfoundry/graphqlws
2222
```
23-
3. Run the example server:
23+
4. Run the tests:
2424
```sh
2525
cd graphqlws
26+
go test
27+
```
28+
3. Run the example server:
29+
```sh
2630
go run graphqlws/examples/server
2731
```
2832

@@ -111,7 +115,23 @@ for _, conn := range subscriptions {
111115
}
112116
```
113117
114-
## License
118+
### Logging
119+
120+
The library uses [logrus](https://github.com/sirupsen/logrus) for logging at the moment.
121+
In the future we might remove those logs entirely to leave logging entirely to developers
122+
using `graphqlws`. For the moment, you can control the logging level of `graphqlws`
123+
by setting it through `logrus`:
124+
125+
```go
126+
import (
127+
log "github.com/sirupsen/logrus"
128+
)
129+
130+
...
131+
132+
log.SetLevel(log.WarnLevel)
133+
```
134+
115135
116136
Copyright (C) 2017 Functional Foundry, LLC.
117137

0 commit comments

Comments
 (0)