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:55:31 +0300
committerMartijn Cuppens <martijn.cuppens@gmail.com>2019-02-11 21:27:14 +0300
commite1f56e3eac72227037937559f44cb5fda519f113 (patch)
tree200d7b114979219202f0f898898c87d136acbcdd /README.md
parentf61cca58c435f6e8e0e49995e910cae315fb0b42 (diff)
#51: rfs documentation: add file locations
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index 1d2fc2d..4c731f3 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ lose the ability to easily and quickly manage and update RFS as a dependency.
## Usage
-In the following examples, this folder structure is assumed:
+In the following examples, this folder structure is assumed (you will probably just use one pre/postprocessor):
```text
project/
@@ -55,17 +55,19 @@ project/
### Sass
```scss
+// .scss syntax:
+// scss/main.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
+// .sass syntax:
+// scss/main.scss
@import "../node_modules/rfs/sass/rfs";
-// .sass syntax:
.title
+responsive-font-size(4rem) // OR +responsive-font-size(64px) OR +rfs(64)
```
@@ -73,14 +75,18 @@ project/
### PostCSS
```postcss
+// postcss/main.css
.title {
responsive-font-size: 4rem; // OR responsive-font-size: 64px; OR rfs: 64;
}
+
+// Handle postcss afterwards (see examples folder for postcss example)
```
### Less
```less
+// less/main.less
@import "../node_modules/rfs/less/rfs";
.title {
@@ -91,6 +97,7 @@ project/
### Stylus
```stylus
+// stylus/main.styl
@import "../node_modules/rfs/stylus/rfs";
.title