diff --git a/README.md b/README.md index 51a8a0f45..192f4a4b1 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,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 Fork Awesome in your web project](http://forkawesome.github.com/Fork-Awesome/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 Fork Awesome font is licensed under the SIL OFL 1.1: - http://scripts.sil.org/OFL @@ -32,8 +35,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 @@ -84,3 +87,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/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 %}
+
+ + +
+
+

The simplest way to get {{ site.forkawesome.name }} in your project is to copy the line below in between the <head> tags of your HTML source files. Then check the examples to start displaying icons. +

+{% highlight html %} + +{% endhighlight %} +

+

Thanks to jsDelivr for providing the CDN for {{ site.forkawesome.name }}

+
+
+

Using CSS

    -
  1. Copy the entire font-awesome directory into your project.
  2. +
  3. Copy the entire fork-awesome directory into your project.
  4. In the <head> of your html, reference the location to your font-awesome.min.css. {% highlight html %} @@ -69,21 +87,6 @@ relative_path: ../
-
- -
- -
-
-

Thanks to jsDelivr, {{ site.forkawesome.name }} is available via a CDN as well.

-

-{% highlight html %} - -{% endhighlight %} -

-
-
-