Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jani Anttonen committed Jan 22, 2019
1 parent 0814521 commit b9f7d00
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ It should contain everything from the protocol to the port.

The interval at which the transport sends batched logs to Loki. **In seconds.**

>`json`
*optional*

Switch to JSON transport instead of Protobuf.

### Example
```js
const { createLogger, transports } = require("winston");
Expand Down Expand Up @@ -52,11 +58,13 @@ And you should have a working, requirable winston-loki package under your projec

Refer to https://github.com/grafana/loki/blob/master/docs/api.md for documentation about the available endpoints, data formats etc.

Grafana Loki *doesn't have any official releases or version numbers* as of now, so if the API is changed, it's going to be fun, but it's working as of now.

### Run tests
```sh
npm test
```

Write new ones under `/test`

TODO: Add protobuf as default mode, remove *got* dependency
TODO: Remove *got* dependency

0 comments on commit b9f7d00

Please sign in to comment.