Merge pull request #123 from feathericon/feature/update_docs

Update docs
feathericon · Jan 20, 2019 · 9417cec46fd48f9bb09470d95b7d3003fc6d90cb · 9417cec
2 parents b6c680e + 6a7f47f
commit 9417cec46fd48f9bb09470d95b7d3003fc6d90cb
Unified Split

Showing with 34 additions and 25 deletions.

+22 −23 README.md

+3 −1 docs/getting-started.html

+1 −0 docs/index.html

BIN src/feathericon.sketch

+6 −1 src/pug/getting-started.pug

+2 −0 src/pug/inc/components/_menu.pug
diff --git a/README.md b/README.md
@@ -1,27 +1,24 @@
-  
-![feathericon](https://raw.githubusercontent.com/featherplain/feathericon/master/docs/img_feathericon_white.png "feathericon")
+  
+# feathericon
+  
+<a href="https://sketch.cloud/s/YJAlO" rel="nofollow">
+  
+  <img src="https://raw.githubusercontent.com/featherplain/feathericon/master/docs/img_feathericon_white.png" alt="feathericon">
+  
+</a>
+  
+<br><br>
+  
+<a href="https://travis-ci.org/feathericon/feathericon">
+  
+  <img src="https://travis-ci.org/feathericon/feathericon.svg?branch=master" alt="Build Status">
+  
+</a>
+  
+<a href="https://www.npmjs.com/package/feathericon">
+  
+  <img src="https://badge.fury.io/js/feathericon.svg" alt="npm version" height="18">
+  
+</a>
+  
+<a href="https://www.npmjs.com/package/feathericon">
+  
+  <img src="https://img.shields.io/npm/dm/feathericon.svg?style=flat" alt="npm downloads">
+  
+</a>
+  
+<a href="https://www.jsdelivr.com/package/npm/feathericon">
+  
+  <img src="https://data.jsdelivr.com/v1/package/npm/feathericon/badge" alt="jsDeliver">
+  
+</a>
+  
+<br><br>
+  
+feathericon is simply generic vector icon collection. The vectors for all the icons are stored in a <a href="https://sketch.cloud/s/YJAlO">Sketch file</a>.
 <br>
-  
-![feathericon](https://raw.githubusercontent.com/featherplain/feathericon/master/docs/img_feathericon_green.png "feathericon")
-  
-
-  
-<h1 align="center">feathericon</h1>
-  
-<p align="center">feathericon is simple, scalable vector icon font for websites, apps.</p>
-  
-<div align="center">
-  
-  <a href="https://travis-ci.org/feathericon/feathericon">
-  
-    <img src="https://travis-ci.org/feathericon/feathericon.svg?branch=master" alt="Build Status">
-  
-  </a>
-  
-  <a href="https://www.npmjs.com/package/feathericon">
-  
-    <img src="https://badge.fury.io/js/feathericon.svg" alt="npm version" height="18">
-  
-  </a>
-  
-  <a href="https://www.npmjs.com/package/feathericon">
-  
-    <img src="https://img.shields.io/npm/dm/feathericon.svg?style=flat" alt="npm downloads">
-  
-  </a>
-  
-  <a href="https://www.jsdelivr.com/package/npm/feathericon">
-  
-    <img src="https://data.jsdelivr.com/v1/package/npm/feathericon/badge" alt="jsDeliver">
-  
-  </a>
-  
-</div>
-  
-<p align="center">Website: <a href="https://feathericon.com/">https://feathericon.com/</a></p>
-  
-
-  
-<p align="center">feathericon v1.0.0 is now available - the brand new design icons 🎉🎉<br>
-  
-You can also use <a href="https://github.com/feathericon/feathericon/releases/tag/v0.11.0">old version</a>.</p>
+  
+Website: <a href="https://feathericon.com/">https://feathericon.com/</a>
 ## Getting Started
 feathericon contains Sketch file, svg files, css / scss files and font files.
@@ -40,6 +37,8 @@ feathericon contains Sketch file, svg files, css / scss files and font files.
  <i class="fe fe-heart"></i>
  ```
+  
+You can use feathericon with CDN files on [jsdeliver](https://www.jsdelivr.com/package/npm/feathericon).
+  
+
 ### Using SVG sprite
 1. Download **[ZIP folder from here](https://github.com/feathericon/feathericon/archive/release.zip)**.
 1. Copy the `svg/sprite/sprite.feathericon.svg` to your project.

diff --git a/docs/getting-started.html b/docs/getting-started.html
@@ -50,6 +50,7 @@ <h1 class="siteBrand__title"><a href="/">feathericon</a></h1>
            <li><a href="https://github.com/feathericon/feathericon/releases" target="_blank" rel="noopener">Releases</a></li>
            <li><a href="https://github.com/feathericon/feathericon" target="_blank" rel="noopener">GitHub</a></li>
            <li><a href="https://github.com/feathericon/feathericon/blob/master/LICENSE" target="_blank" rel="noopener">License</a></li>
+  
+            <li><a href="https://www.jsdelivr.com/package/npm/feathericon" target="_blank" rel="noopener">jsdeliver</a></li>
          </ul>
        </nav>
      </div><a href="https://github.com/feathericon/feathericon" class="github-corner" aria-label="View source on Github"><svg width="70" height="70" viewBox="0 0 250 250" style="fill:#2bdade; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
@@ -59,7 +60,7 @@ <h1 class="siteBrand__title"><a href="/">feathericon</a></h1>
        <h2 class="s-content__title">Getting Started</h2>
        <h3 class="s-content__heading s-content__heading--3" id="basic">Basic</h3>
        <ol>
-  
-          <li>Download ZIP.</li>
+  
+          <li><a href="https://github.com/feathericon/feathericon/archive/release.zip">Download ZIP.</a></li>
          <li>Copy the<code>css/</code>and<code>fonts/</code>directory to your project.</li>
          <li>In the<code>&lt;head&gt;</code>of your html, reference the location to your<code>feathericon.min.css</code>.
            <pre>&lt;link rel=&quot;stylesheet&quot; href=&quot;path/to/css/feathericon.min.css&quot;&gt;</pre>
@@ -68,6 +69,7 @@ <h3 class="s-content__heading s-content__heading--3" id="basic">Basic</h3>
            <pre>&lt;i class="fe fe-heart"&gt;&lt;/i&gt;</pre>
          </li>
        </ol>
+  
+        <p>You can use feathericon with CDN files on<a href="https://www.jsdelivr.com/package/npm/feathericon"> jsdeliver.</a></p>
        <h3 class="s-content__heading s-content__heading--3" id="developers">For developers</h3>
        <ol>
          <li>Install via<a href="https://npmjs.org"> npm</a> or<a href="https://yarnpkg.com/"> yarn.</a>

diff --git a/docs/index.html b/docs/index.html
@@ -50,6 +50,7 @@ <h1 class="siteBrand__title"><a href="/">feathericon</a></h1>
            <li><a href="https://github.com/feathericon/feathericon/releases" target="_blank" rel="noopener">Releases</a></li>
            <li><a href="https://github.com/feathericon/feathericon" target="_blank" rel="noopener">GitHub</a></li>
            <li><a href="https://github.com/feathericon/feathericon/blob/master/LICENSE" target="_blank" rel="noopener">License</a></li>
+  
+            <li><a href="https://www.jsdelivr.com/package/npm/feathericon" target="_blank" rel="noopener">jsdeliver</a></li>
          </ul>
        </nav>
      </div><a href="https://github.com/feathericon/feathericon" class="github-corner" aria-label="View source on Github"><svg width="70" height="70" viewBox="0 0 250 250" style="fill:#2bdade; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>

diff --git a/src/feathericon.sketch b/src/feathericon.sketch
diff --git a/src/pug/getting-started.pug b/src/pug/getting-started.pug
@@ -13,7 +13,8 @@ block body
      h2.s-content__title Getting Started
      h3.s-content__heading.s-content__heading--3#basic Basic
      ol
-  
-        li Download ZIP.
+  
+        li
+  
+          a(href='https://github.com/feathericon/feathericon/archive/release.zip') Download ZIP.
        li
          | Copy the
          code css/
@@ -37,6 +38,10 @@ block body
          |  to start using icons!
          pre &lt;i class="fe fe-heart"&gt;&lt;/i&gt;
+  
+      p
+  
+        | You can use feathericon with CDN files on
+  
+        a(href='https://www.jsdelivr.com/package/npm/feathericon')  jsdeliver.
+  
+
      h3.s-content__heading.s-content__heading--3#developers For developers
      ol
        li

diff --git a/src/pug/inc/components/_menu.pug b/src/pug/inc/components/_menu.pug
@@ -7,3 +7,5 @@ ul.menu
    a(href=url.github.root target="_blank" rel="noopener") GitHub
  li
    a(href=url.github.license target="_blank" rel="noopener") License
+  
+  li
+  
+    a(href='https://www.jsdelivr.com/package/npm/feathericon' target="_blank" rel="noopener") jsdeliver