Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
TheTekton committed Jun 13, 2017
1 parent c52924b commit bcf8668
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,6 @@ npm install -g msvgc
msvgc -f ./path/to/pic.svg -o ./svgComponents/
```

If default params are not set, the current working
directory will be used as the path to .svg files with output in the ./svg directory.

Subdirectories containing .svg files will generate their corresponding react components within a subdirectory in the output path.

The output path contains an index.js that exports all generated components.

`--camelCase` flag creates components with camel-case class names

`--react-native` flag creates components using [react-native-svg](https://github.com/react-native-community/react-native-svg) library
Expand All @@ -31,8 +24,17 @@ The output path contains an index.js that exports all generated components.

`--coffeescript` flag will use CoffeeScript CJSX syntax for creating components

<br />
Then use generated components in your jsx/tsx/cjsx files:
**Notes:**

If default params are not set, the current working
directory will be used as the path to .svg files with output in the ./svg directory.

Subdirectories containing .svg files will generate their corresponding react components within a subdirectory in the output path.

The output path contains an index.js that exports all generated components.

### React JS:
Use generated components in your jsx/tsx/cjsx files:

```js
[...]
Expand Down

0 comments on commit bcf8668

Please sign in to comment.