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-20 00:48:05 +0300
committerMartijn Cuppens <martijn.cuppens@gmail.com>2019-02-11 21:27:14 +0300
commitf61cca58c435f6e8e0e49995e910cae315fb0b42 (patch)
treea556d3c5424026c0cf4e7f6f4b5e885813fcc3e6 /README.md
parent5ed2c4bf5961bebf1f63422830394d4eb732be01 (diff)
#51: rfs documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 28 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4b0bb3c..1d2fc2d 100644
--- a/README.md
+++ b/README.md
@@ -33,16 +33,39 @@ lose the ability to easily and quickly manage and update RFS as a dependency.
## Usage
+In the following examples, this folder structure is assumed:
+
+```text
+project/
+├── postccss/
+│ └── main.css
+├── less/
+│ └── main.less
+├── node_modules/
+│ └── rfs
+│ └── ...
+├── sass/
+│ └── main.sass
+├── scss/
+│ └── main.scss
+└── stylus/
+ └── main.styl
+```
+
### Sass
```scss
+@import "../node_modules/rfs/sass/rfs";
+
// .scss syntax:
.title {
@include responsive-font-size(4rem); // OR @include responsive-font-size(64px); OR @include rfs(64);
}
```
```sss
-# .sass syntax:
+@import "../node_modules/rfs/sass/rfs";
+
+// .sass syntax:
.title
+responsive-font-size(4rem) // OR +responsive-font-size(64px) OR +rfs(64)
```
@@ -58,6 +81,8 @@ lose the ability to easily and quickly manage and update RFS as a dependency.
### Less
```less
+@import "../node_modules/rfs/less/rfs";
+
.title {
.responsive-font-size(4rem); // OR .responsive-font-size(64px); OR .rfs(64);
}
@@ -66,6 +91,8 @@ lose the ability to easily and quickly manage and update RFS as a dependency.
### Stylus
```stylus
+@import "../node_modules/rfs/stylus/rfs";
+
.title
responsive-font-size(4rem) // OR responsive-font-size(64px) OR rfs(64)
```