Skip to content

Commit ecf7f1d

Browse files
feat!: release breaking change as breaking (#634)
Add README note about typescript BREAKING CHANGE: release breaking change (typescript) as breaking
1 parent dbec796 commit ecf7f1d

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Requirements
3535

3636
This component uses ``@edx/frontend-platform`` services such as i18n, analytics, configuration, and the ``AppContext`` React component, and expects that it has been loaded into a micro-frontend that has been properly initialized via ``@edx/frontend-platform``'s ``initialize`` function. `Please visit the frontend template application to see an example. <https://github.com/openedx/frontend-template-application/blob/master/src/index.jsx>`_
3737

38+
As of version 7.x, consuming applications must support typescript.
3839

3940
Environment Variables
4041
====================
@@ -190,4 +191,4 @@ Please do not report security issues in public. Please email [email protected]
190191
.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-component-header.svg
191192
:target: @edx/frontend-component-header
192193
.. |semantic-release| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
193-
:target: https://github.com/semantic-release/semantic-release
194+
:target: https://github.com/semantic-release/semantic-release

0 commit comments

Comments
 (0)