Skip to content

Commit

Permalink
Add LICENSE and Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
danielfdsilva committed Jul 14, 2015
1 parent e807eb1 commit 4c7600f
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 6 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 Development Seed

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
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 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.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
# Collecticons

Showcase of collecticons icon library.
This repo contains the source code for the [Collecticons icon library website](http://devseed.com/collecticons).
If your looking for the actual icon library check [here](https://github.com/developmentseed/collecticons-lib). There's also a webfont generation util for advanced users which is available [here](https://github.com/developmentseed/collecticons-processor).


## Development environment
To set up the development environment for this website, you'll need to install the following on your system:

- [Node and npm](http://nodejs.org/)
- Gulp ( $ npm install -g gulp )

After these basic requirements are met, run the following commands in the website's folder:
```
$ npm install
```

### Getting started

```
$ gulp serve
```
Compiles the website and launches the server making it available at `http://localhost:3000/`

## Contributing
You are free to contribute to the project. If you find a bug and/or have a nice idea about a feature feel free to open an issue or submit your own solution. We'll be more than happy to hear your suggestions. :)

## License
Collecticons is licensed under **The MIT License (MIT)**, see the [LICENSE](LICENSE) file for more details.
8 changes: 4 additions & 4 deletions app/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<meta name="twitter:card" content="summary" />
<meta name="twitter:site" content="@developmentseed" />
<meta name="twitter:title" content="Collecticons">
<meta name="twitter:description" content="An evergroing collection of crisp icons." />
<meta name="twitter:description" content="An evergrowing collection of crisp icons." />
<meta name="twitter:image:src" content="assets/graphics/meta/default-meta-image.png" />
<!--/ Twitter -->

Expand All @@ -22,7 +22,7 @@
<meta property="og:title" content="Collecticons" />
<meta property="og:url" content="http://devseed.com/collecticons/" />
<meta property="og:type" content="website" />
<meta property="og:description" content="An evergroing collection of crisp icons." />
<meta property="og:description" content="An evergrowing collection of crisp icons." />
<meta property="og:image" content="assets/graphics/meta/default-meta-image.png" />
<!--/ OG -->

Expand All @@ -49,7 +49,7 @@
<script id="page-template" type="text/template" class="template">
<header id="site-header" role="banner">
<h1 id="site-title">Collecticons</h1>
<p id="site-description">An evergroing collection of crisp icons.</p>
<p id="site-description">An evergrowing collection of crisp icons.</p>
<p id="site-actions"><a href="collecticons.zip" title="Get the icons!" class="button-download"><span>Download</span></a> <small>V<%= version %> / <%= icons.length %> icons</small></p>
</header>
<main id="site-body" role="main">
Expand Down Expand Up @@ -88,7 +88,7 @@ <h3>Advanced usage</h3>
<section class="stripe about">
<h2 class="stripe-title">About</h2>
<div class="stripe-content prose">
<p>We at Development Seed use iconography in a lot of projects. Some of the icons were built on top of libraries like <a href="https://github.com/Keyamoon/IcoMoon-Free" title="View icoMoon webfont">icoMoon by Keyamoon</a> and others were made in house. This evergrowing collection is a set of the icons we've been using so far and are now available for free under the <a href="" title="View license">XPTO license</a>.
<p>We at Development Seed use iconography in a lot of projects. Some of the icons were designed/built on top of libraries like <a href="https://github.com/Keyamoon/IcoMoon-Free" title="View icoMoon webfont">icoMoon by Keyamoon</a> and others were made in house. This evergrowing collection is a set of the icons we've been using so far and are now available for free under the <a href="https://github.com/developmentseed/collecticons/blob/master/LICENSE" title="View license">The MIT License</a>.
<p>If you feel like contributing to this library checkout our <a href="https://github.com/developmentseed/collecticons-lib" title="View collecticons icon library">collecticons library</a> repo and submit a pull request.</p>
</div>
</section>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "collecticons",
"version": "0.1.0",
"description": "An evergroing collection of crisp icons.",
"description": "An evergrowing collection of crisp icons.",
"repository": {
"type": "git",
"url": "https://github.com/developmentseed/collecticons.git"
Expand Down

0 comments on commit 4c7600f

Please sign in to comment.