Skip to content

Commit ede3938

Browse files
committed
chore: add migration info to readme
1 parent c924c00 commit ede3938

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- [Editing credentials](#editing-credentials)
1515
- [Using in production](#using-in-production)
1616
- [How it works](#how-it-works)
17+
- [How to update from v1 to v2](#how-to-update-from-v1-to-v2)
1718

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

@@ -154,6 +155,12 @@ GOOGLE_KEY=your_google_key
154155
GOOGLE_SECRET=your_google_secret
155156
```
156157

158+
## How to update from v1 to v2
159+
160+
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.
161+
162+
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.
163+
157164
[workflow-image]: https://img.shields.io/github/workflow/status/bitkidd/adonis-credentials/test?style=for-the-badge&logo=github
158165
[workflow-url]: https://github.com/bitkidd/adonis-credentials/actions/workflows/test.yml
159166
[npm-image]: https://img.shields.io/npm/v/@bitkidd/adonis-credentials.svg?style=for-the-badge&logo=npm

0 commit comments

Comments
 (0)