Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add information about v4 release for embroider and typescript users #2440

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ authorization mechanisms__.

* [Managing a current User](guides/managing-current-user.md)
* [GitHub authorization with torii](guides/auth-torii-with-github.md)
* [Upgrading to v4](guides/upgrade-to-v4.md)
* [Upgrading to v3](guides/upgrade-to-v3.md)

**Other Resources**

Expand Down Expand Up @@ -106,9 +108,17 @@ ember install ember-simple-auth
```

### Upgrading from a pre-3.0 release?

The 3.0 release of ember-simple-auth removes previously deprecated code,
introducing some breaking changes, but thankfully there is an
[upgrade guide](guides/upgrade-to-v3.md).
[v3 upgrade guide](guides/upgrade-to-v3.md).

### Upgrading to 4.0 release?

The 4.1 release introduced a `session#setup` that fixes build issues for `typescript` and `embroider` users,
due to ESA using initializers. Consult with the guide in order to fix them
as well as prepare yourself for v5 release which will make it **required**.
[v4 upgrade guide](guides/upgrade-to-v4.md).

## Walkthrough

Expand Down Expand Up @@ -686,6 +696,8 @@ If you're an `ember-mocha` user, we can recommend to check out this
## Other guides

* [Managing current User](guides/managing-current-user.md)
* [Upgrading to v4](guides/upgrade-to-v4.md)
* [Upgrading to v3](guides/upgrade-to-v3.md)

## License

Expand Down