Skip to content
This repository has been archived by the owner on Feb 29, 2024. It is now read-only.

Commit

Permalink
Update docs and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
jgarber623 committed Aug 2, 2019
1 parent 7981569 commit dc33532
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 12 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Changelog

## 3.0.0 / 2019-08-02

### Breaking Changes

- Bump required minimum SVGO version to 1.3.0 ([afa24c6](https://github.com/jgarber623/svgeez/commit/afa24c6)).

### Additional Enhancements

- Refactor command classes ([02f420c](https://github.com/jgarber623/svgeez/commit/02f420c)).
- Refactor specs ([995f950](https://github.com/jgarber623/svgeez/commit/)).
- Update development dependencies.

## 2.0.1 / 2019-01-03

- Expand supported Ruby versions to include 2.6 ([0facfd0](https://github.com/jgarber623/svgeez/commit/0facfd0)).
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,19 @@ If you're using [Bundler](http://bundler.io), add svgeez to your project's Gemfi
```rb
source 'https://rubygems.org'

gem 'svgeez', '~> 2.0'
gem 'svgeez', '~> 3.0'
```

…and hop over to your command prompt and run…

```sh
$ bundle install
bundle install
```

You may also install svgeez directly by issuing the following command:

```sh
$ gem install svgeez
gem install svgeez
```

## Usage
Expand All @@ -56,18 +56,18 @@ You can manually generate an SVG sprite from a folder of SVGs with the `build` c
A basic example:

```sh
$ svgeez build --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images/icons.svg
svgeez build --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images/icons.svg
```

The above example will combine all SVG files in `~/Sites/sixtwothree.org/images/icons` into a single SVG sprite file (`icons.svg`) in `~/Sites/sixtwothree.org/images`.

#### Options and Defaults

|Option|Description|
|---|---|
|`-s`<br>`--source`|Path to the folder of source SVGs (defaults to `./_svgeez`).|
|`-d`<br>`--destination`|Path to the destination file or folder (defaults to `./svgeez.svg`)|
|`--with-svgo`|Optimize SVG sprite file with [SVGO](https://github.com/svg/svgo)|
| Option | Description |
|:----------------------|:------------------------------------------------------------------|
| `-s`, `--source` | Path to folder of source SVGs (defaults to `./_svgeez`). |
| `-d`, `--destination` | Path to destination file or folder (defaults to `./svgeez.svg`) |
| `--with-svgo` | Optimize SVG sprite file with [SVGO](https://github.com/svg/svgo) |

### The `watch` command

Expand All @@ -76,7 +76,7 @@ The `watch` command takes the same arguments as the `build` command but uses the
Tweaking the example from above:

```sh
$ svgeez watch --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images/icons.svg
svgeez watch --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images/icons.svg
```

svgeez will remaing running, watching for new, removed, or updated SVG files in the provided source folder. As SVG files are added, deleted, or modified in the source folder, svgeez will pump out updated SVG sprite files to the destination folder.
Expand All @@ -92,7 +92,7 @@ The first section of Jayden Seric's post, [How to optimize SVG](http://jaydenser
If you have the excellent [SVGO](https://github.com/svg/svgo) utility installed on your system (and the `svgo` command is available in your `PATH`), you can use the `--with-svgo` option and optimize the generated sprite file.

```sh
$ svgeez build --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images/icons.svg --with-svgo
svgeez build --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images/icons.svg --with-svgo
```

Depending on the number of individual SVG files in the source folder, using the `--with-svgo` option can add considerable time to SVG sprite generation.
Expand Down
2 changes: 1 addition & 1 deletion lib/svgeez/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module Svgeez
VERSION = '2.0.1'.freeze
VERSION = '3.0.0'.freeze
end

0 comments on commit dc33532

Please sign in to comment.