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

github.com/twbs/rfs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartijn Cuppens <martijn.cuppens@gmail.com>2017-08-24 12:35:21 +0300
committerMartijn Cuppens <martijn.cuppens@gmail.com>2017-08-24 12:35:21 +0300
commit18377a8a66dd0f4a00a3e8342b132ba9eb63112c (patch)
treef76c876f16eb621126c9cdc453cc959fc2c62bc8
parent1ad3435329112420ac4f0b35fbfc112546467ff0 (diff)
#1: Add instalation documentation
-rw-r--r--README.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md
index 97a801b..4d899de 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,36 @@
[npm-image]: https://img.shields.io/npm/v/rfs.svg
[npm-url]: https://npmjs.org/package/rfs
+## Instalation
+You can use RFS in your project by installing it using a package manager (recommended):
+
+**npm:**
+
+```
+$ npm install rfs --save
+```
+
+**yarn:**
+
+```
+$ yarn add rfs
+```
+
+**Bower:**
+
+```
+$ bower install rfs --save
+```
+
+**Copy/paste (not recommended):**
+
+You can download the RFS SCSS-file and save it in your `scss/` directory. This
+method is not recommended because you lose the ability to easily and quickly
+manage and update RFS as a dependency.
+
+
## About
-RFS stands for Responsive Font-Size, easy to remember, easy to use. It’s a desktop-first approach which **automatically calculates the correct font-size** for every screen width. Desktop-first approach means you just have got to define your font-size for big screens and the font-size will automatically decrease for smaller screens. RFS is a **SCSS-mixin** which generates the responsive css for you.
+RFS stands for Responsive Font-Size, easy to remember, easy to use. This approach **automatically calculates the correct font-size** for every screen width. You just have got to define your font-size for big screens and the font-size will automatically decrease for smaller screens. RFS is a **SCSS-mixin** which generates the responsive css for you.
## The main advantages of using RFS
- Font-sizes will rescale for every screen width, this prevents long words from being chopped off the screen