Skip to content

Commit

Permalink
chore: add migration info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bitkidd committed Feb 4, 2024
1 parent c924c00 commit ede3938
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- [Editing credentials](#editing-credentials)
- [Using in production](#using-in-production)
- [How it works](#how-it-works)
- [How to update from v1 to v2](#how-to-update-from-v1-to-v2)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down Expand Up @@ -154,6 +155,12 @@ GOOGLE_KEY=your_google_key
GOOGLE_SECRET=your_google_secret
```

## How to update from v1 to v2

The new version introduced one main change you'll have to apply manually. You have to add `v2.` to both of your `.key` and `.credentials` files. This will allow in the future change encryption algo without breaking things.

Another thing that has changed is the default file format for `.credentials`, it will always be YAML from now. JSON files will still work, but YAML is just way easier to format and work with.

[workflow-image]: https://img.shields.io/github/workflow/status/bitkidd/adonis-credentials/test?style=for-the-badge&logo=github
[workflow-url]: https://github.com/bitkidd/adonis-credentials/actions/workflows/test.yml
[npm-image]: https://img.shields.io/npm/v/@bitkidd/adonis-credentials.svg?style=for-the-badge&logo=npm
Expand Down

0 comments on commit ede3938

Please sign in to comment.