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@intracto.com>2018-12-14 21:48:42 +0300
committerMartijn Cuppens <martijn.cuppens@gmail.com>2019-02-11 21:27:14 +0300
commit77cc58d7e143299f4f1eb957252bf0e1835659c2 (patch)
treef1c0d16e55fa13acb9f52ef2dded09c0fde97e40 /README.md
parenta516fc87065fff4e578268e59e5f4d1d66515966 (diff)
Documentation update
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 7 insertions, 22 deletions
diff --git a/README.md b/README.md
index 20be7bb..9a28049 100644
--- a/README.md
+++ b/README.md
@@ -21,23 +21,9 @@ RFS (simply the abbreviation for Responsive Font Size) is an font size engine wh
RFS can be installed using a package manager (recommended):
-**npm:**
-
-```sh
-$ npm install rfs --save
-```
-
-**yarn:**
-
-```sh
-$ yarn add rfs
-```
-
-**Bower:**
-
-```sh
-$ bower install rfs --save
-```
+- npm: `npm install rfs`
+- yarn: `yarn add rfs`
+- bower: `bower install rfs --save`
**Copy/paste (not recommended):**
@@ -47,17 +33,16 @@ lose the ability to easily and quickly manage and update RFS as a dependency.
## Usage
-### SCSS
+### Sass
```scss
+// .scss syntax:
.title {
@include responsive-font-size(4rem); // OR @include responsive-font-size(64px); OR @include rfs(64);
}
```
-
-### Sass
-
-```sass
+```sss
+# .sass syntax:
.title
+responsive-font-size(4rem) // OR +responsive-font-size(64px) OR +rfs(64)
```