Skip to content

Commit f12b6fa

Browse files
committed
Update README
1 parent d54be1b commit f12b6fa

File tree

3 files changed

+25
-20
lines changed

3 files changed

+25
-20
lines changed

README.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -149,25 +149,6 @@ and with [babel-preset-env](https://github.com/babel/babel-preset-env) in `.babe
149149

150150
[branch=v0.1](https://github.com/boopathi/react-svg-loader/tree/v0.1)
151151

152-
## Internals
153-
154-
<p align="center">
155-
Input SVG
156-
</p>
157-
<p align="center">↓</p>
158-
<p align="center">
159-
SVG Optimize using <a href="https://github.com/svg/svgo">SVGO</a>
160-
</p>
161-
<p align="center">↓</p>
162-
<p align="center">
163-
Babel Transform with <code>preset=react</code> and <a href="src/plugin.js"><code>plugin=svgToComponent</code></a>
164-
</p>
165-
166-
## Assumptions and Other gotchas
167-
168-
+ Root element is always `<svg>`
169-
+ SVG is optimized using SVGO
170-
171152
## LICENSE
172153

173154
[MIT](https://github.com/boopathi/react-svg-loader/blob/master/LICENSE)

packages/babel-plugin-react-svg/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# babel-plugin-react-svg
22

3-
A plugin that converts svg to a react component
3+
A plugin that converts svg to a react component. Used in [react-svg-loader](/packages/react-svg-loader)
44

55
## Install
66

@@ -118,6 +118,11 @@ import React from 'react';
118118
export default ({ styles = {}, ...props }) => <svg {...props}>...</svg>;
119119
```
120120

121+
## Assumptions and Other gotchas
122+
123+
+ Root element is always `<svg>`
124+
+ SVG is optimized using SVGO
125+
121126
## LICENSE
122127

123128
[MIT](https://github.com/boopathi/react-svg-loader/blob/master/LICENSE)

packages/react-svg-loader/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,25 @@ By default the loader outputs ES2015 code (with JSX compiled to JavaScript using
7070
}
7171
```
7272

73+
## Internals
74+
75+
<p align="center">
76+
Input SVG
77+
</p>
78+
<p align="center">↓</p>
79+
<p align="center">
80+
SVG Optimize using <a href="https://github.com/svg/svgo">SVGO</a>
81+
</p>
82+
<p align="center">↓</p>
83+
<p align="center">
84+
Babel Transform with <code>preset=react</code> and <a href="src/plugin.js"><code>plugin=svgToComponent</code></a>
85+
</p>
86+
87+
## Assumptions and Other gotchas
88+
89+
+ Root element is always `<svg>`
90+
+ SVG is optimized using SVGO
91+
7392
## LICENSE
7493

7594
[MIT](https://github.com/boopathi/react-svg-loader/blob/master/LICENSE)

0 commit comments

Comments
 (0)