Warning about using the module in dev and instructions for running the example

romainberger · romainberger · commit 47460826017d · 2016-06-09T11:32:38.000+02:00
diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ Drop-in replacement of the css-loader, it simply checks the `dir` attribute on t
 
 Uses [rtlcss](https://github.com/MohammadYounes/rtlcss) under the hood.
 
+**Warning** This module should only be used for development. The processing of your css being done server-side, the bundle will include both the regular css and the rtl version, which can make your bundle a lot bigger. If you're using the `extract-text-webpack-plugin`, check out the [webpack-rtl-plugin](https://github.com/romainberger/webpack-rtl-plugin).
+
 ## installation
 
 `npm install rtl-css-loader --save-dev`
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,23 @@
+# rtl-css-loader example
+
+# Usage
+
+```shell
+# install the module dependencies
+cd ..
+npm install
+
+# install the example dependencies
+cd example
+npm install
+
+# run the webpack compilation
+npm run webpack
+
+# start the development server (uses python)
+npm start
+```
+
+Then open your browser at [http://localhost:3000](http://localhost:3000).
+
+To see how the module works, open `index.html` then change the `dir` attribute on the `html` tag.
diff --git a/example/index.html b/example/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html dir="rtl">
+<html dir="ltr">
 <head>
     <title></title>
 </head>
diff --git a/example/package.json b/example/package.json
@@ -1,10 +1,10 @@
 {
-  "name": "rtl-loader-example",
+  "name": "rtl-css-loader-example",
   "version": "1.0.0",
   "description": "",
   "scripts": {
     "start": "python -m SimpleHTTPServer",
-    "webpack": "webpack --watch"
+    "webpack": "webpack"
   },
   "author": "Romain Berger <romain@romainberger.com>",
   "license": "MIT",
