svgeez 1.0.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b5e6d929efa9fcb5c48283aada61cf024d4bdb7
-  data.tar.gz: 86611eebed02b5c8980743bdfe17b6eb044835a6
+SHA256:
+  metadata.gz: 9ec517999af227f154d38ca7c1a785fb061e292601e181213c83a108ffc1ac38
+  data.tar.gz: 389bedd716f094b97b1899afbf1c290a44393d7234ee44d328e5cfd512037cbc
 SHA512:
-  metadata.gz: c626b106b2cf43412576b9592543092c43451158a1a041dc9f14e26c3e0be844fe4598a670282e6cffdb02899e6158618185b654957f5b9e1d19141439f43ecf
-  data.tar.gz: f910a1fc6b3a7d4d355f9aef5586826032c1e1f6c24839510cb6cb9b9cfdafeeb1b6e9dade04e365490280c54f149c747b18a3fc265eed2e61f21678d1dc96f3
+  metadata.gz: bb5f93fde2f014659bf678b4da09866864e84a57d251a04464c03df739055ef09e9a0b5c24f35094a8b147f5c4ad4dbf47a6e6482d27af7e60ab2d38a6f39a6a
+  data.tar.gz: ca874151e7beb400e0819f3ea9ca74ca3489556ee29523d9eada5f3fefabd7eb8ab6374b6cc84b9ac67dd582db633a55e384fbaaa68ae1a657c484e0063d7d82

data/.gitignore

@@ -1,10 +1,28 @@
-/.bundle/
-/.yardoc/
-/_yardoc/
+*.gem
+*.rbc
+/.config
 /coverage/
-/doc/
+/InstalledFiles
 /pkg/
 /spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
 /tmp/
-*.DS_Store
+
+# Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+# Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
 Gemfile.lock
+# .ruby-version
+# .ruby-gemset

data/.reek.yml

@@ -0,0 +1,16 @@
+detectors:
+  DuplicateMethodCall:
+    max_calls: 2
+  IrresponsibleModule:
+    enabled: false
+  TooManyStatements:
+    exclude:
+      - Svgeez::Builder#build
+      - Svgeez::Builder#initialize
+      - Svgeez::Commands::Watch#process
+  UtilityFunction:
+    exclude:
+      - Svgeez::Elements::SymbolElement#element_contents
+
+exclude_paths:
+  - vendor/

data/.rspec

@@ -1,3 +1,2 @@
---color
---format progress
+--order random
 --require spec_helper

data/.rubocop

@@ -0,0 +1,3 @@
+--display-style-guide
+--extra-details
+--parallel

data/.rubocop.yml

@@ -1,5 +1,28 @@
-Metrics/LineLength:
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: disable
+
+Layout/LineLength:
   Enabled: false
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: exception
+
+RSpec/MultipleExpectations:
+  Max: 2
+
 Style/Documentation:
   Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.2.6
+2.4.10

data/.simplecov

@@ -0,0 +1,13 @@
+require 'simplecov-console'
+
+formatters = [SimpleCov::Formatter::HTMLFormatter]
+
+# rubocop:disable Style/IfUnlessModifier
+if RSpec.configuration.files_to_run.length > 1
+  formatters << SimpleCov::Formatter::Console
+end
+# rubocop:enable Style/IfUnlessModifier
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter.new(formatters)
+end

data/.travis.yml

@@ -1,10 +1,22 @@
+dist: bionic
 language: ruby
 rvm:
-  - 2.2.6
-  - 2.3.4
-  - 2.4.1
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+cache: bundler
 before_install:
+  - nvm install node
   - npm install -g svgo
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 notifications:
   email: false
-  slack: sixtwothree:yATLmjTW15443qR7jbCWr3RO
+  slack:
+    rooms:
+      secure: nA0yP2h64kUBM4bs1PrLBfoMvj/u8S1g/Yc0BICCJWpcahUnZiX4Kd87+zprfg0r1nX1Eu+5ileM9U4Z9CeOfNHVma/o5PISliRMgWe3k9na+I66oEybj1u4+a3wA+upXsZQ+RpnJh1aE3A99EdA8plGhAjts3cmdYzcEknDM5wLRxj0V4H7lVzYGHBC4wKWTJ3dEq3uSnYvymxuJI29a8H1bgrlTsTutzwLmEiyDfiXEjUUfoUIE3EVjJdEswJUXmjUPGKB7a/O63ExZj1vtmPAFITw9MeTChbV+5suG0Ibv7dOwqACidqj868HGYHQ7I/G+SwRvJvwWyzmbbFzclupJqudDLPWLKOT8SeUDrezdi9cGg6NI4domRcKRlSSqX1uBDrI7yvhtPeAsB5GFSBCbZVobvVcc1oDitM0KXsQ1kzAKSxnoT0w+egVMfD15ga656agu2qVjiivBBscfSyoNIsQD90j+xGdKBysXGUFE1SxVJ3WtJ6X22PVpDRvjmFmdeT2vnpdA0YB00zvBibGvT+WFP2Iw45YBpXzc3bXj5zRlni79CsehWs44aUfQxNMaPi5G7Dzp+0C/cxDA7DgdU/aVjg6lkXgkuuKE0uybYrTQvWSQ43c8k3eExEMmy3/vFgG82rwGA6STfXf0EUmZ2N6MRI8E1eIU5M78OE=

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+## 3.2.0 / 2020-08-11
+
+- Add `--prefix` option (#79 and #80)
+- Update development Ruby version to 2.4.10 (8d517c1)
+
+## 3.1.0 / 2020-01-20
+
+- Expand supported Ruby versions to include 2.7 (bcc23b5)
+
+## 3.0.0 / 2019-08-02
+
+### Breaking Changes
+
+- Bump required minimum SVGO version to 1.3.0 (afa24c6)
+
+### Additional Enhancements
+
+- Refactor command classes (02f420c)
+- Refactor specs ()
+- Update development dependencies
+
+## 2.0.1 / 2019-01-03
+
+- Expand supported Ruby versions to include 2.6 (0facfd0)
+
+## 2.0.0 / 2018-12-04
+
+- Refactor classes to use `attr_reader`s (c62780f)
+- Change required Ruby versions and liberalize dependency constraints (35fcadb)
+- Change project Ruby version to 2.4.9 (301d341)
+- Bump required SVGO version to 1.1.1 (28741fc)
+
+## Previous Releases
+
+See [the Releases page on GitHub](https://github.com/jgarber623/svgeez/releases) for details on previously released versions.

data/CODE_OF_CONDUCT.md

@@ -5,9 +5,9 @@
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
@@ -23,7 +23,7 @@ include:
 Examples of unacceptable behavior by participants include:
 
 * The use of sexualized language or imagery and unwelcome sexual attention or
-advances
+  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+reported by contacting the project team at jason@sixtwothree.org. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -68,7 +68,9 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -1,19 +1,16 @@
 # Contributing to svgeez
 
-I'd love to have your help improving svgeez! If you'd like to pitch in, you can do so in a number of ways:
+There are a couple ways you can help improve svgeez:
 
-1. Look through open [Issues](https://github.com/jgarber623/svgeez/issues).
-1. Review any open [Pull Requests](https://github.com/jgarber623/svgeez/pulls).
-1. [Fork svgeez](#get-set-up-to-contribute) and fix an open Issue or add your own feature.
-1. File new Issues if you have a good idea or see a bug and don't know how to fix it yourself. _Only do this after you've made sure the behavior or problem you're seeing isn't already documented in an open Issue._
+1. Fix an existing [issue][issues] and submit a [pull request][pulls].
+1. Review open [pull requests][pulls].
+1. Report a new [issue][issues]. _Only do this after you've made sure the behavior or problem you're observing isn't already documented in an open issue._
 
-I definitely appreciate your interest in (and help improving) svgeez. Thanks!
+## Getting Started
 
-## Installation
+svgeez is developed using Ruby 2.4.10 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.org/jgarber623/svgeez).
 
-svgeez is written in [Ruby](https://www.ruby-lang.org/en/) (version 2.2.6) and development dependencies are managed using the [Bundler](http://bundler.io/) gem. [Travis CI builds](https://travis-ci.org/jgarber623/svgeez) use Ruby 2.2.6, 2.3.4, and 2.4.1.
-
-I manage Ruby versions with [rbenv](https://github.com/rbenv/rbenv). I'd recommend you do the same or use a similar Ruby version manager ([chruby](https://github.com/postmodern/chruby/) or [RVM](https://rvm.io/) come to mind). Once you've installed Ruby 2.2.6 using your method of choice, install the project's gems by running:
+Before making changes to svgeez, you'll want to install Ruby 2.4.10. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.4.10 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install
@@ -21,37 +18,31 @@ bundle install
 
 …from the root of the project.
 
-In order for the test suite to run properly, [SVGO](https://github.com/svg/svgo/) must be installed (and the `svgo` command must be available in your PATH). This is most easily achieved by installing [Node.js](https://nodejs.org/) and running:
+In order for the test suite to run properly, [SVGO](https://github.com/svg/svgo) must be installed (and the `svgo` command must be available in your `PATH`). This is most easily achieved by installing [Node.js](https://nodejs.org) and running:
 
 ```sh
 npm install -g svgo
 ```
 
-## Get set up to contribute
-
-Contributing to svgeez is pretty straightforward:
+## Making Changes
 
-1. Fork the svgeez repo and clone it.
-1. Install development dependencies as outlined [above](#installation).
-1. Create a feature branch for the issue or new feature you're looking to tackle: `git checkout -b your-descriptive-branch-name`.
+1. Fork and clone the project's repo.
+1. Install development dependencies as outlined above.
+1. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
 1. _Write some code!_
-1. Build (`bundle exec rake build`) and install (`bundle exec rake install`) your updated code.
-1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rake`.
-1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`.
-1. Push the branch to your fork of svgeez: `git push origin your-descriptive-branch-name`.
-1. Create a new Pull Request and I'll give it a look!
+1. Build (`bin/rake build`) and install (`bin/rake install`) your updated code.
+1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bin/rake`.
+1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://chris.beams.io/posts/git-commit/) for tips on writing useful Git commit messages.)_
+1. Push the branch to your fork: `git push -u origin my-new-feature`.
+1. Create a new [pull request][pulls] and we'll review your changes.
 
 ## Code Style
 
-Code styles are like opinions: Everyone's got one and yours is better than mine. Here's how svgeez should be written:
-
-- Use two-space indentation in Ruby.
-- No trailing whitespace and blank lines should have whitespace removed.
-- Prefer single quotes over double quotes unless interpolating.
-- Follow the conventions you see in the existing source code as best as you can.
+Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org) syntax. There are [plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended you install the EditorConfig plugin for your editor of choice.
 
-svgeez's formatting guidelines are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org/) syntax. There are [a number of great plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. EditorConfig takes the hassle out of syntax-specific formatting.
-
-Additionally, [Rubocop](https://github.com/bbatsov/rubocop) can be used to help identify possible trouble areas in your code. Run `bundle exec rake rubocop` to generate Rubocop's static code analysis report.
+Additionally, [Rubocop](https://github.com/bbatsov/rubocop) can be used to help identify possible trouble areas in your code. Run `bin/rubocop` to generate Rubocop's static code analysis report.
 
 Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.
+
+[issues]: https://github.com/jgarber623/svgeez/issues
+[pulls]: https://github.com/jgarber623/svgeez/pulls

data/Gemfile

@@ -2,3 +2,13 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in svgeez.gemspec
 gemspec
+
+gem 'pry-byebug', '~> 3.9'
+gem 'rake', '~> 13.0'
+gem 'reek', '~> 6.0'
+gem 'rspec', '~> 3.9'
+gem 'rubocop', '~> 0.89.0'
+gem 'rubocop-performance', '~> 1.7'
+gem 'rubocop-rspec', '~> 1.42'
+gem 'simplecov', '~> 0.18.5'
+gem 'simplecov-console', '~> 0.7.2'

data/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2015 Jason Garber
+Copyright (c) 2015-present Jason Garber
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -2,11 +2,12 @@
 
 **A Ruby gem for automatically generating an SVG sprite from a folder of SVG icons.**
 
-[![Gem Version](https://img.shields.io/gem/v/svgeez.svg?label=gem%20version)](https://rubygems.org/gems/svgeez)
-[![Downloads](https://img.shields.io/gem/dt/svgeez.svg)](https://rubygems.org/gems/svgeez)
-[![Build Status](https://img.shields.io/travis/jgarber623/svgeez/master.svg?label=build%20status)](https://travis-ci.org/jgarber623/svgeez)
-[![Code Climate](https://img.shields.io/codeclimate/github/jgarber623/svgeez.svg)](https://codeclimate.com/github/jgarber623/svgeez)
-[![Coverage](https://img.shields.io/codeclimate/coverage/github/jgarber623/svgeez.svg)](https://codeclimate.com/github/jgarber623/svgeez/coverage)
+[![Gem](https://img.shields.io/gem/v/svgeez.svg?style=for-the-badge)](https://rubygems.org/gems/svgeez)
+[![Downloads](https://img.shields.io/gem/dt/svgeez.svg?style=for-the-badge)](https://rubygems.org/gems/svgeez)
+[![Build](https://img.shields.io/travis/jgarber623/svgeez/main.svg?style=for-the-badge)](https://travis-ci.org/jgarber623/svgeez)
+[![Dependencies](https://img.shields.io/depfu/jgarber623/svgeez.svg?style=for-the-badge)](https://depfu.com/github/jgarber623/svgeez)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/svgeez.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/svgeez)
+[![Coverage](https://img.shields.io/codeclimate/c/jgarber623/svgeez.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/svgeez/code)
 
 If you're using an [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) icon system in your Web projects, svgeez can help speed up your workflow by automating the SVG sprite generation process. Run svgeez alongside your existing project (or integrate it into your current build system); add, edit, or delete SVG files from a folder; and marvel as svgeez generates a single SVG sprite file ready for inclusion in your user interface.
 
@@ -16,33 +17,33 @@ _For more on why SVG sprites are the bee's knees as far as icon systems go, give
 
 - Provides a [CLI](https://en.wikipedia.org/wiki/Command-line_interface) for generating SVG sprite files.
 - Integrates with existing projects (e.g. alongside a Rails application using [Foreman](https://github.com/ddollar/foreman)).
-- Optionally optimizes SVG files with [SVGO](https://github.com/svg/svgo/).
+- Optionally optimizes SVG sprite file with [SVGO](https://github.com/svg/svgo).
 
 ## Getting Started
 
-Before installing and using svgeez, you'll want to have Ruby 2.2.6 (or newer) installed on your computer. There are plenty of ways to go about this, but my preference is [rbenv](https://github.com/sstephenson/rbenv). If you're developing on a Mac and using [Homebrew](http://brew.sh/), installing rbenv is [super easy](https://github.com/sstephenson/rbenv#homebrew-on-mac-os-x).
-
-svgeez _might_ work with other versions of Ruby, but it's developed in 2.2.6 and automatically tested against 2.3.4 and 2.4.1 by [Travis CI](https://travis-ci.org/jgarber623/svgeez).
+Before installing and using svgeez, you'll want to have Ruby 2.4 (or newer) installed on your computer. There are plenty of ways to go about this, but my preference is [rbenv](https://github.com/sstephenson/rbenv). svgeez is developed using Ruby 2.4.10 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.org/jgarber623/svgeez).
 
 ## Installation
 
-If you're using Bundler, add svgeez to your project's Gemfile:
+If you're using [Bundler](http://bundler.io), add svgeez to your project's Gemfile:
 
 ```rb
-ruby '2.2.6'
+source 'https://rubygems.org'
 
-source 'https://rubygems.org' do
-  gem 'svgeez'
-end
+gem 'svgeez', '~> 3.0'
 ```
 
 …and hop over to your command prompt and run…
 
-`$ bundle`
+```sh
+bundle install
+```
 
 You may also install svgeez directly by issuing the following command:
 
-`$ gem install svgeez`
+```sh
+gem install svgeez
+```
 
 ## Usage
 
@@ -55,18 +56,19 @@ 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 source SVGs with [SVGO](https://github.com/svg/svgo/) before sprite generation (non-destructive)|
+| 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`)   |
+| `-p`, `--prefix`      | Optional prefix to append to generated `id` attribute values      |
+| `--with-svgo`         | Optimize SVG sprite file with [SVGO](https://github.com/svg/svgo) |
 
 ### The `watch` command
 
@@ -75,7 +77,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.
@@ -88,13 +90,13 @@ The first section of Jayden Seric's post, [How to optimize SVG](http://jaydenser
 
 ### Optimizing generated files with SVGO
 
-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 source SVGs before generating the sprite file.
+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
 ```
 
-Optimizing source SVG files with SVGO is done on-the-fly and the original files are left intact. 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.
+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.
 
 ## Working with SVG sprites
 
@@ -104,7 +106,7 @@ For example, a file named `menu.svg` in `~/Sites/sixtwothree.org/images/icons` w
 
 ```svg
 <symbol id="icons-menu" viewBox="0 0 32 32">
-    <path d="…"/>
+  <path d="…"/>
 </symbol>
 ```
 
@@ -116,21 +118,21 @@ To use an svgeez-generated SVG sprite file, first include the file's contents at
 
 In a Rails 4.1.x or lower application:
 
-```erb
+```html
 <body>
-    <!-- Your page’s awesome content goes here! -->
+  <!-- Your page’s awesome content goes here! -->
 
-    <%= raw Rails.application.assets.find_asset('icons.svg') %>
+  <%= raw Rails.application.assets.find_asset('icons.svg') %>
 </body>
 ```
 
 In a Rails 4.2.x or 5 application:
 
-```erb
+```html
 <body>
-    <!-- Your page’s awesome content goes here! -->
+  <!-- Your page’s awesome content goes here! -->
 
-    <%= raw Rails.application.assets_manifest.find_sources('icons.svg').first %>
+  <%= raw Rails.application.assets_manifest.find_sources('icons.svg').first %>
 </body>
 ```
 
@@ -138,9 +140,9 @@ Or, with PHP:
 
 ```html
 <body>
-    <!-- Your page’s awesome content goes here! -->
+  <!-- Your page’s awesome content goes here! -->
 
-    <?php include_once('path/to/icons.svg'); ?>
+  <?php include_once('path/to/icons.svg'); ?>
 </body>
 ```
 
@@ -152,27 +154,27 @@ Next, wherever you want to include an icon in your user interface, use HTML simi
 
 A more complete example from a Rails 4.1.x or lower application's layout file:
 
-```erb
+```html
 <body>
-    <button>
-        <svg><use xlink:href="#icons-menu"></svg>
-        Menu
-    </button>
+  <button>
+    <svg><use xlink:href="#icons-menu"></svg>
+    Menu
+  </button>
 
-    <%= raw Rails.application.assets.find_asset('icons.svg') %>
+  <%= raw Rails.application.assets.find_asset('icons.svg') %>
 </body>
 ```
 
 A more complete example from a Rails 4.2.x or 5 application's layout file:
 
-```erb
+```html
 <body>
-    <button>
-        <svg><use xlink:href="#icons-menu"></svg>
-        Menu
-    </button>
+  <button>
+    <svg><use xlink:href="#icons-menu"></svg>
+    Menu
+  </button>
 
-    <%= raw Rails.application.assets_manifest.find_sources('icons.svg').first %>
+  <%= raw Rails.application.assets_manifest.find_sources('icons.svg').first %>
 </body>
 ```
 
@@ -184,26 +186,26 @@ For smaller icon sets, this may be an acceptable balance of user and developer n
 
 Icons embedded with the inline `<use>` technique will inherit their fill color from the nearest parent's `color` value, but this can be overriden with CSS:
 
-```css
+```scss
 button {
-    color: #333;
+  color: #333;
 }
 
 button svg {
-    fill: #c00; // Absent this declaration, the icon’s fill color would be #333
+  fill: #c00; // Absent this declaration, the icon’s fill color would be #333
 }
 ```
 
 ## Improving svgeez
 
-You want to help make svgeez better? Hell yeah! I like your enthusiasm. For more on how you can help, check out [CONTRIBUTING.md](https://github.com/jgarber623/svgeez/blob/master/CONTRIBUTING.md).
+You want to help make svgeez better? Hell yeah! I like your enthusiasm. For more on how you can help, check out [CONTRIBUTING.md](https://github.com/jgarber623/svgeez/blob/main/CONTRIBUTING.md).
 
 ### Donations
 
 If diving into Ruby isn't your thing, but you'd still like to support svgeez, consider making a donation! Any amount—large or small—is greatly appreciated. As a token of my gratitude, I'll add your name to the [Acknowledgments](#acknowledgments) below.
 
-[![Donate via Square Cash](https://img.shields.io/badge/square%20cash-$jgarber-28c101.svg)](https://cash.me/$jgarber)
-[![Donate via Paypal](https://img.shields.io/badge/paypal-jgarber-009cde.svg)](https://www.paypal.me/jgarber)
+[![Donate via Square Cash](https://img.shields.io/badge/square%20cash-$jgarber-28c101.svg?style=for-the-badge)](https://cash.me/$jgarber)
+[![Donate via Paypal](https://img.shields.io/badge/paypal-jgarber-009cde.svg?style=for-the-badge)](https://www.paypal.me/jgarber)
 
 ## Acknowledgments
 
@@ -214,14 +216,15 @@ svgeez benefited greatly from the hard work done by the folks working on the fol
 - [Mercenary](https://github.com/jekyll/mercenary)
 - [Listen](https://github.com/guard/listen)
 
-Additionally, Chris Coyier's [CSS Tricks](https://css-tricks.com/) posts linked above got me interested in SVG sprites.
+Additionally, Chris Coyier's [CSS Tricks](https://css-tricks.com) posts linked above got me interested in SVG sprites.
 
 Lastly, the sample icons in `spec/fixtures/icons` are from [Brent Jackson](https://github.com/jxnblk)'s [Geomicons Open](https://github.com/jxnblk/geomicons-open) icon set.
 
-svgeez is written and maintained by [Jason Garber](https://github.com/jgarber623).
+svgeez is written and maintained by [Jason Garber](https://sixtwothree.org).
 
 ### Additional Contributors
 
+- [Abhinav Mishra](https://github.com/abhinavmsra)
 - [Brett Wilkins](https://github.com/bwilkins)
 - [danny](https://github.com/f96q)
 - [Denis Hovart](https://github.com/dhovart)
@@ -229,4 +232,4 @@ svgeez is written and maintained by [Jason Garber](https://github.com/jgarber623
 
 ## License
 
-svgeez is freely available under the [MIT License](http://opensource.org/licenses/MIT). Use it, learn from it, fork it, improve it, change it, tailor it to your needs.
+svgeez is freely available under the [MIT License](https://opensource.org/licenses/MIT). Use it, learn from it, fork it, improve it, change it, tailor it to your needs.