From 3885874e7ba99cc5afcaf592c8c548b0f70a8202 Mon Sep 17 00:00:00 2001
From: Jakub Chrzanowski <jakub.chrzanowski@jetbrains.com>
Date: Wed, 22 Apr 2020 10:21:51 +0200
Subject: [PATCH] README - introduction, badges, document scaffold, useful
 links

---
 README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 59 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 12a4a32..818425c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,61 @@
-IntelliJ Plugin Template
-========================
+# IntelliJ Plugin Template
 
+![official JetBrains project](https://jb.gg/badges/official-flat-square.svg)
 ![Tests](https://github.com/hsz/intellij-plugin-template/workflows/Tests/badge.svg)
+
+IntelliJ Plugin Template is a repository that provides a pure boilerplate for creating a plugin project with ease
+designed as a GitHub template repository (check the [Creating a repository from a template][gh-template] article).
+The main goal for this Template is to speed up the setup phase of the plugin development for the new as well as existing
+developers by preconfiguring the project scaffold, CI and linking to the proper documentation pages as well as keeping
+everything in the most straightforward manner.
+
+We can detail here the following parts:
+
+- Gradle configuration
+- Sample code:
+  - listeners - project and dynamic plugin lifecycle
+  - services - project- and application-related services 
+  - actions - basic action with shortcut binding
+- Plugin Manifest file
+- README Template
+- CI based on GitHub actions
+- Release and changelog maintenance flow
+
+## Getting started
+
+TODO
+
+## Gradle
+
+TODO
+
+## Sample Code
+
+TODO
+
+## Plugin Manifest File
+
+TODO
+
+## Continuous Integration
+
+TODO
+
+## Release Flow
+
+TODO
+
+## Useful Links
+
+- [IntelliJ Platform SDK DevGuide][sdk-docs]
+- [IntelliJ SDK Code Samples][code-samples]
+- [JetBrains Platform Slack][slack]
+- [IntelliJ IDEA Open API and Plugin Development][forum]
+- [GitHub Actions][gh-actions]
+
+[gh-template]: https://help.github.com/en/enterprise/2.20/user/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template
+[gh-actions]: https://help.github.com/en/actions
+[sdk-docs]: https://www.jetbrains.org/intellij/sdk/docs
+[code-samples]: https://github.com/JetBrains/intellij-sdk-code-samples
+[slack]: https://plugins.jetbrains.com/slack
+[forum]: https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development