Add some documentation

Author: t-moennich

README.md

@@ -1,6 +1,46 @@
-# typescript-plugin-css-module-types
+[![Build Status](https://travis-ci.com/GodLesZ/typescript-plugin-css-module-types.svg?branch=master)](https://travis-ci.com/GodLesZ/typescript-plugin-css-module-types)
+[![codecov](https://codecov.io/gh/GodLesZ/typescript-plugin-css-module-types/branch/master/graph/badge.svg)](https://codecov.io/gh/GodLesZ/typescript-plugin-css-module-types)
 
-Typescript plugin to get intellisense and validation for SCSS imports as [CSS Modules](https://github.com/css-modules/css-modules).
+# TS Types for CSS Modules
+
+This Typescript plugin hooks itself into the Typescript Language Service 
+to provide intellisense and validation for SCSS imports as [CSS Modules](https://github.com/css-modules/css-modules).
+
+It supports `.module.scss` imports containing valid SCSS code.
+
+## Features
+The following SCSS (and CSS Modules) feature are supported:
+
+```scss
+// :global and :local identifier and functions
+:global .global-class { }
+:global(.global-class) { }
+:local .local-class { }
+:local(.local-class) { }
+
+// Variables
+$color: red;
+.className {
+  color: $color;
+}
+
+// Loops
+$color: red;
+@for $section from 1 to 5 {
+    .section-#{$section} {
+        color: $color;
+    }
+}
+```
+
+Also **imports** are supported.\
+As of now there's also a limited path-resolution support to allow **module imports**.
+
+```scss
+@import "./relative/path/some/file";
+
+@import "absolute/path/some/file";
+```
 
 # Thanks
 

package.json

@@ -1,10 +1,12 @@
 {
   "name": "typescript-plugin-css-module-types",
+  "description": "CSS modules (based on scss) support for TypeScript",
   "version": "0.1.0",
-  "main": "build/index.js",
   "author": "GodLesZ <[email protected]>",
   "license": "MIT",
-  "description": "CSS modules (based on scss) support for TypeScript",
+  "bugs": "https://github.com/GodLesZ/typescript-plugin-css-module-types/issues",
+  "homepage": "https://github.com/GodLesZ/typescript-plugin-css-module-types",
+  "repository": "https://github.com/GodLesZ/typescript-plugin-css-module-types",
   "keywords": [
     "css",
     "scss",
@@ -13,6 +15,8 @@
     "plugin",
     "typescript"
   ],
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
   "files": [
     "build"
   ],