Remove FlameTheme from install docs, mark as deprecated

lightspeed · Nov 22, 2019 · 1b73125 · 1b73125
1 parent ac511b6
commit 1b73125
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -55,23 +55,6 @@ Add this `<link>` tag to your `<head>` to load the required fonts:
 />
 ```
 
-Alternatively, if you use `React Helmet` or can render to the `<head>` tag in JavaScript, you may use the provided `FlameFonts` component:
-
-```jsx
-import { Helmet } from 'react-helmet';
-import { FlameFonts } from '@lightspeed/flame/Core';
-
-// ..
-render() {
-  return (
-    <Helmet>
-      <title>My Title</title>
-      <FlameFonts />
-    </Helmet>
-  );
-}
-```
-
 ### Hook the theme provider, load global styles, and import components
 
 In order to have the proper styling, it is necessary to load the theme object into the application.

diff --git a/packages/flame/CHANGELOG.md b/packages/flame/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Refer to the [CONTRIBUTING guide](https://github.com/lightspeed/flame/blob/master/.github/CONTRIBUTING.md) for more info.
 
+## [Unreleased]
+
+### Deprecated
+
+- FlameTheme component will be removed from the next major version of Flame, use [link](https://github.com/lightspeed/flame#link-fonts) instead
+
 ## 1.2.3 - 2019-11-22
 
 ### Fixed

diff --git a/packages/flame/src/Core/index.tsx b/packages/flame/src/Core/index.tsx
@@ -106,6 +106,8 @@ const FlameTheme: React.FunctionComponent<FlameThemeProps> = ({
   return <ThemeProvider theme={{ ...selectedTheme, ...themeOverrides }}>{children}</ThemeProvider>;
 };
 
+// TODO: Will be deprecated in v2, instead, use the link tag directly:
+// https://github.com/lightspeed/flame#link-fonts
 const FlameFonts: React.FunctionComponent = () => (
   <link
     href="https://fonts.googleapis.com/css?family=Lato:400,700&subset=latin-ext"