1
1
mirror of https://github.com/namibia/file-icon-vectors.git synced 2024-12-26 01:17:29 +00:00

Added notes about future release(s)

This commit is contained in:
Daniel Hendricks 2018-10-21 13:39:10 -05:00
parent 3c316c87a2
commit a260f746e6

View File

@ -1,3 +1,4 @@
[![Looking for Remote Work](https://f001.backblazeb2.com/file/hendricks/tmp/autumn-theme_looking-for-work.jpg)](https://www.danhendricks.com/contact/ "Looking for Remote Work")
[![Author](https://img.shields.io/badge/author-Daniel%20M.%20Hendricks-lightgrey.svg?colorB=9900cc )](https://www.danhendricks.com?utm_source=github.com&utm_medium=campaign&utm_content=button&utm_campaign=dmhendricks%2Ffile-icon-vectors) [![Author](https://img.shields.io/badge/author-Daniel%20M.%20Hendricks-lightgrey.svg?colorB=9900cc )](https://www.danhendricks.com?utm_source=github.com&utm_medium=campaign&utm_content=button&utm_campaign=dmhendricks%2Ffile-icon-vectors)
[![Icon Count](https://img.shields.io/badge/icon%20count-1170-red.svg)](https://fileicons.org/?utm_source=github.com&utm_medium=referral&utm_content=button&utm_campaign=dmhendricks%2Ffile-icon-vectors) [![Icon Count](https://img.shields.io/badge/icon%20count-1170-red.svg)](https://fileicons.org/?utm_source=github.com&utm_medium=referral&utm_content=button&utm_campaign=dmhendricks%2Ffile-icon-vectors)
[![Release](https://img.shields.io/github/release/dmhendricks/file-icon-vectors.svg)](https://github.com/dmhendricks/file-icon-vectors/releases) [![Release](https://img.shields.io/github/release/dmhendricks/file-icon-vectors.svg)](https://github.com/dmhendricks/file-icon-vectors/releases)
@ -26,6 +27,14 @@ Currently, there are three icon sets in the `dist/icons` directory:
* **Vivid** - Inspired by [Erlen Masson](https://www.sketchappsources.com/svg-resource/1856-vector-file-type-icons-sketch-freebie-resource.html?utm_source=github.com&utm_medium=referral&utm_content=link&utm_campaign=dmhendricks%2Ffile-icon-vectors) * **Vivid** - Inspired by [Erlen Masson](https://www.sketchappsources.com/svg-resource/1856-vector-file-type-icons-sketch-freebie-resource.html?utm_source=github.com&utm_medium=referral&utm_content=link&utm_campaign=dmhendricks%2Ffile-icon-vectors)
* **Square Outline** (in progress) - Modified from and inspired by [Cotne Nazarashvili](https://github.com/thecotne/square-file-icons) * **Square Outline** (in progress) - Modified from and inspired by [Cotne Nazarashvili](https://github.com/thecotne/square-file-icons)
**Next release:**
- Over 500 new icons
- A new set for dark backgrounds ([preview](https://fileicons.org/?branch=develop&view=high-contrast))
- CDNJS hosting
Once that is released, I'd like to focus on a webfont, ideally where you can create your own file icons with stacking, just like Font Awesome.
## Installation ## Installation
### NPM ### NPM
@ -40,7 +49,7 @@ npm install file-icon-vectors
bower install file-icon-vectors bower install file-icon-vectors
``` ```
**NB!** Due to a versioning issue, the current release is not available from Bower. It will be corrected with the next release. :rotating_light: **NB!** Because I didn't use semver, the current release is not available from Bower. It will be corrected with the next release.
### Composer ### Composer
@ -48,6 +57,8 @@ bower install file-icon-vectors
composer require dmhendricks/file-icon-vectors composer require dmhendricks/file-icon-vectors
``` ```
(I know, it doesn't below on Packagist, but 15% of my downloads are coming from there, so some people must prefer it.)
## Quick Start ## Quick Start
To display a file icon, simply link to one or all of the icon set CSS files in the `css` directory: To display a file icon, simply link to one or all of the icon set CSS files in the `css` directory:
@ -154,6 +165,7 @@ For example, [fileicons.org](https://fileicons.org/) reads this file to dynamica
Generic icons include `blank.svg`, `folder.svg`, `image.svg`. Generic icons include `blank.svg`, `folder.svg`, `image.svg`.
:rotating_light: **BREAKING CHANGE:** I will be removing the generic `folder.svg` from each collection in favor of the upcoming ["Extra"](https://fileicons.org/?branch=develop&view=extra) set. Follow this repo if you'd like to be notified when that happens.
## Special Thanks ## Special Thanks