Merge pull request #11 from styled-components/update-readme

Update readme with features and contribution instructions

Author: undeadcat

README.md

@@ -1,24 +1,60 @@
 # webstorm-styled-components
-React Styled Components Language Support in IntelliJ/Webstorm
+Support for styled-components 💅 in WebStorm
 
-# Motivation
-https://github.com/styled-components/styled-components/issues/176
+The plugin can be installed in WebStorm, IntelliJ IDEA Ultimate, PhpStorm, PyCharm Pro, and RubyMine v2017.2 and above.
 
 # Installation
-An alpha version is here! Here are the steps you need for installations
-- Download the latest release from here https://github.com/styled-components/webstorm-styled-components/releases/
-- Extract the archive
-- In Webstorm, Hit <kbd>CMD</kbd>+<kbd>SHIFT</kbd>+<kbd>A</kbd> to bring up actions pane. Then select *Add Plugin From Disk*
+To install the plugin:
+- Download the latest [release](https://github.com/styled-components/webstorm-styled-components/releases/)
+- In WebStorm, hit <kbd>Cmd</kbd>/<kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>A</kbd> to bring up the actions pane. Then select *Add Plugin From Disk*
 - Select `webstorm-styled-components.zip` to install the plugin
-- You should find your StyledComponents instances highlighted automatically
 
-# Known Issues
-The plugin only works with Webstorm 2017
+# Features
+With this plugin you can enjoy the full coding assistance for styled-components 💅
 
-# Current Progress
-![alt text](https://d26dzxoao6i3hh.cloudfront.net/items/1Z0q2R2Y3F0b0H091436/Image%202017-08-30%20at%204.23.48%20PM.png?v=589202df)
+- Start typing to get code completion for CSS properties and values
 
-# TODO
+<img src="https://blog.jetbrains.com/webstorm/files/2017/09/ws-st-comp-css-completion.png" width=680>
+
+- Hit <kbd>Alt</kbd>-<kbd>Enter</kbd> to see available intentions and quick-fixes
+
+<img src="https://blog.jetbrains.com/webstorm/files/2017/09/ws-st-comp-intentions.png" width=680>
+
+- Start typing in the interpolation to see completion suggestions for JavaScript variables, methods and functions
+
+<img src="https://blog.jetbrains.com/webstorm/files/2017/09/ws-st-comp-js-completion.png" width=680>
+
+- Cmd/Ctrl-click on the JavaScript symbol to do to its definition
+
+# Limitations
+- The plugin only works with the JetBrains IDEs version 2017.2 or above.
+- It is not yet available on [JetBrains Plugin Repository](https://plugins.jetbrains.com/). When installing the plugin from disk, you won't get update notifications for it.
+- Semicolons at the end on the line should be outside the string, e.g. `color: ${props => props.primary ? 'white' : 'palevioletred'};`
+
+# Contributing to the plugin
+Please report any issue with the plugin on [GitHub](https://github.com/styled-components/webstorm-styled-components/issues). We welcome your pull requests.
+
+The plugin is written in [Kotlin](https://kotlinlang.org/) and uses [Gradle](https://gradle.org/).
+
+**To start contributing**
+1. Clone this repository.
+2. Open the resulting directory in a recent version of Intellij IDEA (2017.*) using 'Open project'.
+3. In the 'Import Project from Gradle' dialog, accept the default settings.
+
+* To **run tests** use `test` task (from the IDEA UI search for 'Execute Gradle Task' and select `test` or run `./gradlew test` from the command line)
+
+* To **launch IDEA** with the plugin built from your current sources use `runIde`
+
+* To **prepare a zip archive** for deployment use `buildPlugin`
+
+The project structure and dependencies are defined in [build.gradle](https://github.com/styled-components/webstorm-styled-components/blob/master/build.gradle).
+
+**Useful links**
+* [gradle-intellij-plugin](https://github.com/JetBrains/gradle-intellij-plugin) documentation on available Gradle tasks and build.gradle configuration options
+* [IDEA SDK documentation](https://www.jetbrains.org/intellij/sdk/docs/basics/getting_started.html) describes IDEA plugin structure in general
+* [Kotlin language reference](https://kotlinlang.org/docs/reference/) 
+
+# Todo
 - Smart Indentation when opening backticks and pressing enter.
 
 # License (MIT)

build.gradle

@@ -8,13 +8,17 @@ repositories {
 }
 
 intellij {
+    //defines the version of IDEA distribution that should be used as a dependency
     version 'IU-2017.2'
+    // plugins to be used as build dependencies
     plugins = ['JavaScriptLanguage', 'CSS', 'less']
+    //name is used for zip archive when building plugin
     pluginName 'webstorm-styled-components'
     downloadSources false
 }
 
 sourceSets {
+    //mark directory as test sources
     test {
         java.srcDir 'src/test'
     }