diff --git a/README.md b/README.md
index c07bc5fbc264..8f2be20fbea6 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-
+
Simple Icons
Over 2400 Free SVG icons for popular brands. See them all on one page at SimpleIcons.org. Contributions, corrections & requests can be made on GitHub.
@@ -17,7 +17,7 @@ Over 2400 Free SVG icons for popular brands. See them all on one page at :information_source: We ask that all users read our [legal disclaimer](./DISCLAIMER.md) before using icons from Simple Icons.
+> :information\_source: We ask that all users read our [legal disclaimer](./DISCLAIMER.md) before using icons from Simple Icons.
### General Usage
@@ -62,7 +62,7 @@ Where `[COLOR]` is optional, and can be replaced by the [hex colors](https://dev
```
-### Node Usage
+### Node Usage
The icons are also available through our npm package. To install, simply run:
@@ -71,6 +71,7 @@ npm install simple-icons
```
All icons are imported from a single file, where `[ICON SLUG]` is replaced by a capitalized [slug]. We highly recommend using a bundler that can tree shake such as [webpack](https://webpack.js.org/) to remove the unused icon code:
+
```javascript
// Import a specific icon by its slug as:
// import { si[ICON SLUG] } from 'simple-icons'
@@ -113,7 +114,7 @@ If you need to iterate over all icons, use:
import * as icons from 'simple-icons';
```
-#### TypeScript Usage
+#### TypeScript Usage
Type definitions are bundled with the package.
@@ -121,7 +122,7 @@ Type definitions are bundled with the package.
import type { SimpleIcon } from 'simple-icons';
```
-### PHP Usage
+### PHP Usage
The icons are also available through our Packagist package. To install, simply run:
@@ -147,34 +148,34 @@ echo file_get_contents('path/to/package/icons/simpleicons.svg');
| Extension | Author |
| :-- | :-- |
-| [Angular Module](https://github.com/avmaisak/ngx-simple-icons)
| [@avmaisak](https://github.com/avmaisak) |
-| [Blazor Nuget](https://github.com/TimeWarpEngineering/timewarp-simple-icons)
| [@TimeWarpEngineering](https://github.com/TimeWarpEngineering) |
-| [Blender add-on](https://github.com/mondeja/simple-icons-blender)
| [@mondeja](https://github.com/mondeja) |
-| [Drawio library](https://github.com/mondeja/simple-icons-drawio)
| [@mondeja](https://github.com/mondeja) |
-| [Drupal module](https://www.drupal.org/project/simple_icons)
| [Phil Wolstenholme](https://www.drupal.org/u/phil-wolstenholme) |
-| [Figma plugin](https://www.figma.com/community/plugin/1149614463603005908/Simple-Icons)
| [@LitoMore](https://github.com/LitoMore) |
-| [Flutter package](https://pub.dev/packages/simple_icons)
| [@jlnrrg](https://jlnrrg.github.io/) |
-| [Framer component](https://github.com/LitoMore/simple-icons-framer)
| [@LitoMore](https://github.com/LitoMore) |
-| [Hexo plugin](https://github.com/nidbCN/hexo-simpleIcons)
| [@nidbCN](https://github.com/nidbCN/) |
-| [Home Assistant plugin](https://github.com/vigonotion/hass-simpleicons)
| [@vigonotion](https://github.com/vigonotion/) |
-| [Hugo module](https://github.com/foo-dogsquared/hugo-mod-simple-icons)
| [@foo-dogsquared](https://github.com/foo-dogsquared) |
-| [Java library](https://github.com/silentsoft/simpleicons4j)
| [@silentsoft](https://github.com/silentsoft) |
-| [Jetpack Compose library](https://github.com/DevSrSouza/compose-icons)
| [@devsrsouza](https://github.com/devsrsouza/) |
-| [Kirby plugin](https://github.com/runxel/kirby3-simpleicons)
| [@runxel](https://github.com/runxel) |
-| [LaTeX package](https://github.com/ineshbose/simple-icons-latex)
| [@ineshbose](https://github.com/ineshbose) |
-| [Laravel Package](https://github.com/ublabs/blade-simple-icons)
| [@adrian-ub](https://github.com/adrian-ub) |
-| [Python package](https://github.com/sachinraja/simple-icons-py)
| [@sachinraja](https://github.com/sachinraja) |
-| [React package](https://github.com/icons-pack/react-simple-icons)
| [@wootsbot](https://github.com/wootsbot) |
-| [Solid package](https://github.com/x64Bits/solid-icons)
| [@x64Bits](https://github.com/x64Bits) |
-| [Stream Deck icon pack](https://github.com/mackenly/simple-icons-stream-deck)
| [@mackenly](https://github.com/mackenly) |
-| [Svelte package](https://github.com/icons-pack/svelte-simple-icons)
| [@wootsbot](https://github.com/wootsbot) |
-| [Vue 3 package](https://github.com/wyatt-herkamp/vue3-simple-icons)
| [@wyatt-herkamp](https://github.com/wyatt-herkamp) |
-| [Vue package](https://github.com/mainvest/vue-simple-icons)
| [@noahlitvin](https://github.com/noahlitvin) |
-| [WordPress plugin](https://wordpress.org/plugins/simple-icons/)
| [@tjtaylo](https://github.com/tjtaylo) |
+| [Angular Module](https://github.com/avmaisak/ngx-simple-icons)
| [@avmaisak](https://github.com/avmaisak) |
+| [Blazor Nuget](https://github.com/TimeWarpEngineering/timewarp-simple-icons)
| [@TimeWarpEngineering](https://github.com/TimeWarpEngineering) |
+| [Blender add-on](https://github.com/mondeja/simple-icons-blender)
| [@mondeja](https://github.com/mondeja) |
+| [Drawio library](https://github.com/mondeja/simple-icons-drawio)
| [@mondeja](https://github.com/mondeja) |
+| [Drupal module](https://www.drupal.org/project/simple_icons)
| [Phil Wolstenholme](https://www.drupal.org/u/phil-wolstenholme) |
+| [Figma plugin](https://www.figma.com/community/plugin/1149614463603005908/Simple-Icons)
| [@LitoMore](https://github.com/LitoMore) |
+| [Flutter package](https://pub.dev/packages/simple_icons)
| [@jlnrrg](https://jlnrrg.github.io/) |
+| [Framer component](https://github.com/LitoMore/simple-icons-framer)
| [@LitoMore](https://github.com/LitoMore) |
+| [Hexo plugin](https://github.com/nidbCN/hexo-simpleIcons)
| [@nidbCN](https://github.com/nidbCN/) |
+| [Home Assistant plugin](https://github.com/vigonotion/hass-simpleicons)
| [@vigonotion](https://github.com/vigonotion/) |
+| [Hugo module](https://github.com/foo-dogsquared/hugo-mod-simple-icons)
| [@foo-dogsquared](https://github.com/foo-dogsquared) |
+| [Java library](https://github.com/silentsoft/simpleicons4j)
| [@silentsoft](https://github.com/silentsoft) |
+| [Jetpack Compose library](https://github.com/DevSrSouza/compose-icons)
| [@devsrsouza](https://github.com/devsrsouza/) |
+| [Kirby plugin](https://github.com/runxel/kirby3-simpleicons)
| [@runxel](https://github.com/runxel) |
+| [LaTeX package](https://github.com/ineshbose/simple-icons-latex)
| [@ineshbose](https://github.com/ineshbose) |
+| [Laravel Package](https://github.com/ublabs/blade-simple-icons)
| [@adrian-ub](https://github.com/adrian-ub) |
+| [Python package](https://github.com/sachinraja/simple-icons-py)
| [@sachinraja](https://github.com/sachinraja) |
+| [React package](https://github.com/icons-pack/react-simple-icons)
| [@wootsbot](https://github.com/wootsbot) |
+| [Solid package](https://github.com/x64Bits/solid-icons)
| [@x64Bits](https://github.com/x64Bits) |
+| [Stream Deck icon pack](https://github.com/mackenly/simple-icons-stream-deck)
| [@mackenly](https://github.com/mackenly) |
+| [Svelte package](https://github.com/icons-pack/svelte-simple-icons)
| [@wootsbot](https://github.com/wootsbot) |
+| [Vue 3 package](https://github.com/wyatt-herkamp/vue3-simple-icons)
| [@wyatt-herkamp](https://github.com/wyatt-herkamp) |
+| [Vue package](https://github.com/mainvest/vue-simple-icons)
| [@noahlitvin](https://github.com/noahlitvin) |
+| [WordPress plugin](https://wordpress.org/plugins/simple-icons/)
| [@tjtaylo](https://github.com/tjtaylo) |
## Contribute
-[![Good first issues open](https://img.shields.io/github/issues/simple-icons/simple-icons/good%20first%20issue?label=good%20first%20issues&logo=git&logoColor=white)](https://github.com/simple-icons/simple-icons/labels/good%20first%20issue)
+[![Good first issues open](https://img.shields.io/github/issues/simple-icons/simple-icons/good%20first%20issue?label=good%20first%20issues\&logo=git\&logoColor=white)](https://github.com/simple-icons/simple-icons/labels/good%20first%20issue)
Information describing how to contribute can be found in the file [CONTRIBUTING.md](https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md)