docs(all): add basic description for readme

adam-sokolowski · Apr 18, 2020 · 13147ef · 13147ef
1 parent 84e28ef
commit 13147ef
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,11 @@
-# Collection of 195 flags for countries
+# Collection of 195 country flags 
 
-As SCSS as it gets flag's collection
+A combination of pure `CSS`, Font and `base64` symbols covering all recognised countries.
 
 
+## Scripts
+    `sass:compile`: Compiles SASS code into CSS output
+    `storybook:compile`: Compile and serve storybook with flags playground
+
 
 TODO: Implement countries teritorries
diff --git a/package.json b/package.json
@@ -49,4 +49,4 @@
     "stylelint-scss": "3.16.1"
   },
   "dependencies": {}
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -49,4 +49,4 @@ @@
         "stylelint-scss": "3.16.1"
       },
       "dependencies": {}
-    }
+    }