Merge pull request #8 from Kosai106/feat/remove-example

chore: remove example code
Kosai106 · Aug 6, 2020 · 526f578 · 526f578
2 parents 6310995 + f7d794e
commit 526f578
Show file tree

Hide file tree

Showing 19 changed files with 23 additions and 11,196 deletions.
diff --git a/README.md b/README.md
@@ -40,47 +40,44 @@ src/
 ```
 
 OR
+
 ```bash
 # .env
 REACT_APP_ICON_PATH=src/images/icons
 ```
 
 ```jsx
 // Code
-import React from 'react';
-import Icon from 'react-icon-system';
+import React from "react";
+import Icon from "react-icon-system";
 
-const YourComponent = props => (
-  <Icon src="alert" />
-)
+const YourComponent = () => <Icon src="alert" />;
 ```
 
 ### Pro tips
 
 Instead of using a static colour for your SVGs, use `currentColor`. This way you can dynamically change the icon colour by using CSS.
 
-__Example:__
-```css
-.color-red {
-  color: red;
-}
-.color-blue {
-  color: blue;
-}
-.color-yellow {
-  color: yellow;
-}
+**Example:**
+
+```svg
+// SVG icon
+<svg width="24" height="24" xmlns="http://www.w3.org/2000/svg">
+  <path stroke="currentColor" fill="none" d="..." />
+                    ^
+</svg>
 ```
 
 ```jsx
-import React, { Fragment } from 'react';
-import Icon from 'react-icon-system';
-
-const YourComponent = props => (
-  <Fragment>
-    <Icon src="alert" className="color-red" />
-    <Icon src="info" className="color-blue" />
-    <Icon src="warning" className="color-yellow" />
-  </Fragment>
-)
+// Code
+import React from "react";
+import Icon from "react-icon-system";
+
+const YourComponent = () => (
+  <div>
+    <Icon src="alert" style={{ color: "red" }} />
+    <Icon src="info" style={{ color: "blue" }} />
+    <Icon src="warning" style={{ color: "yellow" }} />
+  </div>
+);
 ```
diff --git a/example/.gitignore b/example/.gitignore
diff --git a/example/README.md b/example/README.md
diff --git a/example/package.json b/example/package.json
diff --git a/example/public/favicon.ico b/example/public/favicon.ico
diff --git a/example/public/index.html b/example/public/index.html
diff --git a/example/public/manifest.json b/example/public/manifest.json
diff --git a/example/src/App.css b/example/src/App.css
diff --git a/example/src/App.js b/example/src/App.js
diff --git a/example/src/App.test.js b/example/src/App.test.js
diff --git a/example/src/images/icons/heart.svg b/example/src/images/icons/heart.svg
diff --git a/example/src/images/icons/home.svg b/example/src/images/icons/home.svg
diff --git a/example/src/images/icons/inbox.svg b/example/src/images/icons/inbox.svg
diff --git a/example/src/images/icons/monitor.svg b/example/src/images/icons/monitor.svg
diff --git a/example/src/index.css b/example/src/index.css
diff --git a/example/src/index.js b/example/src/index.js
diff --git a/example/src/logo.svg b/example/src/logo.svg