diff options
author | Julien Deswaef <judeswae@thoughtworks.com> | 2018-03-08 00:57:40 +0300 |
---|---|---|
committer | Julien Deswaef <judeswae@thoughtworks.com> | 2018-03-08 00:57:58 +0300 |
commit | 74d88fb8dc492623e8be32c61c1d358a605a5e77 (patch) | |
tree | aafec158c519872d4b422d8db44ed4fbd9ca1930 /src/doc | |
parent | 6ff0fda5092823379a68f162c5c086ac50697a45 (diff) |
Adds link to Get Started in README and improve CDN tutorial
Diffstat (limited to 'src/doc')
-rw-r--r-- | src/doc/README.md-nobuild | 11 | ||||
-rw-r--r-- | src/doc/get-started.html | 35 |
2 files changed, 28 insertions, 18 deletions
diff --git a/src/doc/README.md-nobuild b/src/doc/README.md-nobuild index 45e88cb82..82e70b757 100644 --- a/src/doc/README.md-nobuild +++ b/src/doc/README.md-nobuild @@ -11,6 +11,9 @@ A tremendous gratitude is given to the whole team behind [Font Awesome](https:// Though If you believe in distributed open source design and wish to be part of this new adventure, please start submitting patches and suggestions of improvement. +## How to use +There is a full page in our documentation website that explains [how to use {{ site.forkawesome.name }} in your web project]({{ site.forkawesome.url}}get-started/). It ranges from just pointing to a CSS file on a CDN, hosting it on your own server or even adapting the LESS and SCSS files to your own liking. + ## License - The {{ site.forkawesome.name }} font is licensed under the SIL OFL 1.1: - http://scripts.sil.org/OFL @@ -34,8 +37,8 @@ with the following format: And constructed with the following guidelines: * Breaking backward compatibility bumps the major (and resets the minor and patch) -* New additions, including new icons, without breaking backward compatibility bumps the minor (and resets the patch) -* Bug fixes, changes to brand logos, and misc changes bumps the patch +* Big changes, without breaking backward compatibility, bumps the minor (and resets the patch) +* Bug fixes, small adaptations, adding a few icons and misc changes bumps the patch * The fork started from FontAwesome 4.7 (last commit by Dave is [bdfa9823](https://github.com/ForkAwesome/Fork-Awesome/commits/master?after=b0bc8f6fb74e05c987ef7ce1525cd3ab8390a1c3+69)). * The project starts at version 1.0.0. All references to versions before the fork are named 0.4.7 @@ -86,3 +89,7 @@ Or serve it on a local server on http://localhost:7998/Fork-Awesome/: To deploy the project and documentation on GH pages: $ jgd -n + +## Badges + +[![](https://data.jsdelivr.com/v1/package/npm/fork-awesome/badge)](https://www.jsdelivr.com/package/npm/fork-awesome) diff --git a/src/doc/get-started.html b/src/doc/get-started.html index 13e552e7c..577d8692d 100644 --- a/src/doc/get-started.html +++ b/src/doc/get-started.html @@ -11,6 +11,24 @@ relative_path: ../ {% include jumbotron.html %} <div class="container"> + <section class="get-started-CDN margin-top-lg" id="get-started-CDN"> + <h2 class="page-header clearfix"> + Use a CDN for {{ site.forkawesome.name }} + <span class="label label-default text-base pull-right">simple</span> + </h2> + + <div class="row"> + <div class="col-md-12"> + <p>The simplest way to get {{ site.forkawesome.name }} in your project is to copy the line below in between the <code><head></code> tags of your HTML source files. Then check the <a href="{{ page.relative_path }}examples/">examples</a> to start displaying icons. + <p> +{% highlight html %} +<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/fork-awesome@{{ site.forkawesome.version }}/css/fork-awesome.min.css" integrity="{% sri_hash css/fork-awesome.min.css %}" crossorigin="anonymous"> +{% endhighlight %} + </p> + <p>Thanks to <a href="https://www.jsdelivr.com/package/npm/fork-awesome">jsDelivr</a> for providing the CDN for {{ site.forkawesome.name }}</p> + </div> + </div> + </section> <section class="get-started-download" id="get-started-download"> <h2 class="page-header clearfix"> @@ -38,7 +56,7 @@ relative_path: ../ <h3>Using CSS</h3> <ol> - <li>Copy the entire <code>font-awesome</code> directory into your project.</li> + <li>Copy the entire <code>fork-awesome</code> directory into your project.</li> <li> In the <code><head></code> of your html, reference the location to your font-awesome.min.css. {% highlight html %} @@ -69,21 +87,6 @@ relative_path: ../ </div> </section> - <section class="get-started-CDN margin-top-lg" id="get-started-CDN"> - <h2 class="page-header">Using {{ site.forkawesome.name }} with a CDN</h2> - </section> - - <div class="row"> - <div class="col-md-12"> - <p>Thanks to <a href="https://www.jsdelivr.com">jsDelivr</a>, {{ site.forkawesome.name }} is available via a CDN as well.</p> - <p> -{% highlight html %} -<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/fork-awesome@{{ site.forkawesome.version }}/css/fork-awesome.min.css" integrity="{% sri_hash css/fork-awesome.min.css %}" crossorigin="anonymous"> -{% endhighlight %} - </p> - </div> - </div> - <section class="get-started-more margin-top-lg" id="get-started-more"> <h2 class="page-header">More Information</h2> </section> |