Polish README

gradle · 03b49f6b111b9af361879a892b920e538361ba99 · cbeams committed May 17, 2016

This commit was signed with a verified signature.

cbeams Chris Beams

GPG key ID: 3D214F8F5BC5ED73 Learn about signing commits · May 17, 2016 · 03b49f6 · bamboo
1 parent b32f447
commit 03b49f6b111b9af361879a892b920e538361ba99
Unified Split

Showing with 32 additions and 2 deletions.

+32 −2 README.md
diff --git a/README.md b/README.md
@@ -1,4 +1,34 @@
-Kotlin Scripting
+Gradle Script Kotlin
+====================
+
+[![status](https://builds.gradle.org/app/rest/builds/buildType:GradleScriptKotlin_Master/statusIcon)](https://builds.gradle.org/viewType.html?buildTypeId=GradleScriptKotlin_Master)
+[![license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
+
+Welcome! _Gradle Script Kotlin_ provides support for writing [Gradle](http://gradle.org) build scripts using JetBrains' [Kotlin](http://kotlinlang.org) language. It aims to provide Gradle users with a rich, flexible and statically-typed approach to developing build logic in conjunction with the best IDE and tooling experience possible.
+
+You can read more about the project in our [announcement blog post](http://gradle.org/blog/kotlin-meets-gradle) and check out the [frequently asked questions](https://github.com/gradle/gradle-script-kotlin/wiki/Frequently-Asked-Questions) in the project wiki.
+
+
+Getting Started
+---------------
+
+The fastest way to get up and running with a Kotlin-based Gradle build is to work with one of the [samples](samples). You'll find complete instructions in the README there.
+
+
+Issue Tracking
+--------------
+
+Found a bug? Have an idea for an improvement? Feel free to [add an issue](../../issues).
+
+If you're dealing with what you believe to be an issue with Kotlin itself or the Kotlin Plugin for IDEA, you may want to search JetBrains' [YouTrack](https://youtrack.jetbrains.com/issues/KT) first to see if it is a known issue. In any case, feel free to add an issue here for it as well. We'd like to know and track what our users are experiencing regardless whether the issue is with Gradle Script Kotlin or with Kotlin itself.
+
+
+Staying in Touch
 ----------------
 
-Kotlin language support for Gradle build scripts.
+Come chat with us in the #gradle channel of the public [Kotlin Slack](http://kotlinslackin.herokuapp.com/) instance.
+
+
+License
+-------
+Like the rest of Gradle, _Gradle Script Kotlin_ is released under version 2.0 of the [Apache License](LICENSE.md).