Skip to content

Commit

Permalink
Merge pull request #82 from axiomhq/doc-upgrade-section
Browse files Browse the repository at this point in the history
document migration process to v1.x
  • Loading branch information
dasfmi authored Sep 28, 2023
2 parents a82c7c0 + 7ff3967 commit 9c067c3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,22 @@ This is a monorepo, for specific documentation, check out the different projects
* [`@axiomhq/winston`](./packages/winston): A [winston](https://github.com/winstonjs/winston) transport which sends logs to Axiom.
* [`@axiomhq/pino`](./packages/pino): A [pino](https://github.com/pinojs/pino) transport which sends logs to Axiom.


## Migrate to v1.x

- Pass the credentials as an object to Axiom client, this package no longer reads them from the environment variables.
do:
```ts
const axiom = new Axiom({
token: process.env.AXIOM_TOKEN,
});
```
instead of:
```ts
const axiom = new Axiom();
```


## License

Distributed under the [MIT License](LICENSE).
Expand Down

0 comments on commit 9c067c3

Please sign in to comment.