Skip to content

Commit

Permalink
Merge pull request #77 from NipunaRanasinghe/docs2
Browse files Browse the repository at this point in the history
Update README with overview and intended users sections
  • Loading branch information
NipunaRanasinghe committed Jul 1, 2024
2 parents 0e5d818 + 6039295 commit a9f65fd
Showing 1 changed file with 28 additions and 11 deletions.
39 changes: 28 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,22 @@

---

The IntelliJ Ballerina plugin provides the Ballerina development capabilities in IntelliJ IDEA. Click the links below for instructions on how to download, install, and use the features of the IntelliJ plugin.
## Overview
The Ballerina IntelliJ plugin provides [Ballerina Swan Lake](https://ballerina.io/) language development capabilities within IntelliJ IDEA. While it offers a [subset of features](getting-started/plugin-features/README.md#plugin-features) compared to the [Ballerina VSCode extension](https://marketplace.visualstudio.com/items?itemName=WSO2.ballerina), it is designed to meet the specific needs of those working within the IntelliJ ecosystem.

> **Note:** This plugin is being developed as an experimental and community-driven project. The plugin is fully open-source, and we welcome contributions!
## Intended Users

This plugin is mainly targeted at **Ballerina library developers** who seek:
- Robust interoperability between Ballerina and Java
- A native development experience within IntelliJ IDEs

Therefore, if you do not fall into the above categories, and looking for a more feature-rich experience (including graphical programming capabilities) with Ballerina, we recommend using the official [Ballerina VSCode extension](https://ballerina.io/learn/vs-code-extension/).

## Plugin Guide

Click the links below for instructions on how to download, install, and use the features of the IntelliJ plugin.

- [**Installing the plugin**](getting-started/plugin-installation/README.md#installing-the-plugin)
- [Installing using the ZIP file](getting-started/plugin-installation/README.md#installing-using-the-zip-file)
Expand Down Expand Up @@ -35,15 +50,17 @@ The IntelliJ Ballerina plugin provides the Ballerina development capabilities in

Below you can see the plugin versions that correspond to the versions of the IntelliJ Platform.

**Plugin Version**|**Platform Version Compatibility**
:-----:|:-----:
0.8.0 - 0.8.2 | IntelliJ IDEA 2016.3 - 2016.4
0.8.3 - 0.981.0 | IntelliJ IDEA 2016.3 - 2017.2
0.982.0 - 0.991.0 | IntelliJ IDEA 2017.3 - 2018.2
0.991.1 - 1.2.1 | IntelliJ IDEA 2018.3 - 2019.3
1.2.2 - 1.2.x | IntelliJ IDEA 2018.3 - 2020.2
2.0.0 | IntelliJ IDEA 2022.0 - 2024.1
| **Plugin Version** | **Platform Version Compatibility** |
|:------------------:|:----------------------------------:|
| 0.8.0 - 0.8.2 | IntelliJ IDEA 2016.3 - 2016.4 |
| 0.8.3 - 0.981.0 | IntelliJ IDEA 2016.3 - 2017.2 |
| 0.982.0 - 0.991.0 | IntelliJ IDEA 2017.3 - 2018.2 |
| 0.991.1 - 1.2.1 | IntelliJ IDEA 2018.3 - 2019.3 |
| 1.2.2 - 1.2.x | IntelliJ IDEA 2018.3 - 2020.2 |
| 2.0.0 | IntelliJ IDEA 2022.0 - 2024.1 |

## Useful links
* Use the ballerina-dev@googlegroups.com mailing list to discuss code changes to the Ballerina project.
* Chat live with us on our [Discord server](https://discord.gg/ballerinalang).

* Chat live with us on our [Discord community](https://discord.com/invite/wAJYFbMrG2).
* Post technical questions on the Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.
* For more details on how to engage with the community, see [Community](https://ballerina.io/community/).

0 comments on commit a9f65fd

Please sign in to comment.