Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ForkAwesome/Fork-Awesome.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulien Deswaef <judeswae@thoughtworks.com>2018-03-08 00:57:40 +0300
committerJulien Deswaef <judeswae@thoughtworks.com>2018-03-08 00:57:58 +0300
commit74d88fb8dc492623e8be32c61c1d358a605a5e77 (patch)
treeaafec158c519872d4b422d8db44ed4fbd9ca1930 /README.md
parent6ff0fda5092823379a68f162c5c086ac50697a45 (diff)
Adds link to Get Started in README and improve CDN tutorial
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
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)