Docs: update docs

README.md

@@ -23,6 +23,31 @@ or
 $ yarn add rcs-core
 ```
 
+## Example
+
+1. Fill your library with all selectors (we assume there is just one CSS file)
+
+```js
+rcs.fillLibraries(fs.readFileSync('./src/styles.css', 'utf8'));
+
+// excluding specific selectors
+rcs.selectorsLibrary.setExclude('selector-to-ignore');
+```
+
+2. Rewrite all files
+
+> **Note:** Do not forget to replace your CSS file
+
+```js
+const css = rcs.replace.css(fs.readFileSync('./src/styles.css', 'utf8'));
+const js = rcs.replace.js(fs.readFileSync('./src/App.js', 'utf8'));
+const html = rcs.replace.html(fs.readFileSync('./src/index.html', 'utf8'));
+
+fs.writeFileSync('./dist/styles.css', css);
+fs.writeFileSync('./dist/App.js', js);
+fs.writeFileSync('./dist/index.html', html);
+```
+
 ## API documentation
 - [rcs.stats](docs/api/stats.md)
 - [rcs.replace](docs/api/replace.md)

docs/api/baselibrary.md

@@ -134,7 +134,7 @@ Example:
 const rcs = require('rcs-core');
 
 rcs.baseLibrary.setReserved('a'); // or:
-rcs.baseLibrary.setReserved(['a', 'b']); 
+rcs.baseLibrary.setReserved(['a', 'b']);
 
 // the value will not be mapped to either 'a' or 'b'
 rcs.baseLibrary.set('something');
@@ -175,7 +175,7 @@ Example:
 ```js
 const rcs = require('rcs-core');
 
-rcs.baseLibrary.setPrefix('lib-'); 
+rcs.baseLibrary.setPrefix('lib-');
 rcs.baseLibrary.set('my-id'); // sets to 'lib-a'
 
 rcs.baseLibrary.get('my-id'); // 'lib-a'
@@ -195,7 +195,7 @@ Example:
 ```js
 const rcs = require('rcs-core');
 
-rcs.baseLibrary.setSuffix('-bad'); 
+rcs.baseLibrary.setSuffix('-bad');
 rcs.baseLibrary.set('my-id'); // sets to 'a-bad'
 
 rcs.baseLibrary.get('my-id'); // 'a-bad'

docs/api/filllibraries.md

@@ -1,6 +1,6 @@
 # rcs.fillLibraries
 
-> This fills `selectorLibrary` and `keyframesLibrary` with all necessary information. Just put in your CSS code.
+> This fills `selectorLibrary`, `keyframesLibrary` and `cssVariablesLibrary` with all necessary information. Just put in your CSS code.
 
 > **Note:** Put your stylesheets in here before you call any [rcs.replace](replace.md) method.