Skip to content

README: add note about V2 addons #62

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.

Sign up for GitHub

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

Open
machty wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README: add note about V2 addons #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@

Provides flags for features in Ember, allowing you to write code that will work
with whatever version the consuming application is on. This addon is intended
to help addon authors write backwards/forwards compatibility code.
to help V1 addon authors write backwards/forwards compatibility code.

The flags are replaced at build time with boolean literals (`true` or `false`)
by a Babel transform. When ran through a minifier (with dead code elimination) the entire section will be stripped, meaning that the section of code which is not used
will not be added to production builds - zero cost compatibility!

### Note for V2 Addons

This package should not be used within [V2 Addons](https://rfcs.emberjs.com/id/0507-embroider-v2-package-format/). Instead, please use [`@embroider/macros`](https://github.com/embroider-build/embroider/tree/main/packages/macros), which provides a very similar API to `ember-compatibility-helpers`.

## Installation

```
Expand Down