Skip to content

Commit

Permalink
Updated documentation and added global warning option to package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
Akaryatrh committed Feb 29, 2016
1 parent c6291f2 commit f9b441f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -17,6 +17,8 @@ Using **svg** in a project is great for many reasons (scalable size, all element
That's where **svg-assets** comes to the rescue !
It'll parse any template file to find `<svga>` tags and replace them with related assets files.

Let's say you have a file called `my-pretty-chart.svg` located in your `/path-of-your-assets` folder.
Now you can add a new tag `<svga>my-pretty-chart.svg</svga>` in one of your template file and **svg-assets** will find and replace it with the orginal `svg` file. That way, you don't need to pollute your template files with svg sources.


## Installation
Expand All @@ -27,7 +29,7 @@ Installing globally will give you access to the `svg-assets` command anywhere on
npm install -g svg-assets
```

## Usage
## Options
------------------

svg-assets comes with a few **options**. These options will be used by default (except `directory` and `assets`), and any of them will be replaced by defined ones.
Expand Down
1 change: 1 addition & 0 deletions package.json
Expand Up @@ -6,6 +6,7 @@
"homepage": "https://github.com/Akaryatrh/svg-assets",
"bugs": "https://github.com/Akaryatrh/svgAssets/issues",
"keywords": [ "svg", "replace", "file" ],
"preferGlobal": true,
"repository": {
"type": "git",
"url": "https://github.com/Akaryatrh/svg-assets"
Expand Down

0 comments on commit f9b441f

Please sign in to comment.