Skip to content
This repository was archived by the owner on May 8, 2024. It is now read-only.

Commit 717c7c6

Browse files
committed
Review/Readme
Signed-off-by: jessica-tw <jessica.olinda@zup.com.br>
1 parent 75b81f6 commit 717c7c6

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
1818
## **About**
1919

20-
**StackSpot IntelliJ Plugin** is a plugin that extends [STK CLI](https://docs.stackspot.com/latest/docs/stk-cli/) to IntelliJ and allows you to create a StackSpot project, apply plugins, and many more features. But all this is inside of your favorite IDE.
20+
**StackSpot IntelliJ Plugin** extends [**STK CLI**](https://docs.stackspot.com.br/docs/stk-cli/) to IntelliJ and allows you to create a StackSpot project, apply plugins, and many more features.
2121

2222
## **Getting started**
2323

@@ -28,26 +28,26 @@
2828

2929
### **Gradle Commands**
3030

31-
Always use `./gradlew clean` to be sure that the change you made are in the last binary.
31+
You need to use **`./gradlew clean`** to make sure the changes you made are in the last binary. Now, follow:
3232

33-
To build plugin to install in your IDE use:
33+
1. Build a plugin to install in your IDE, run:
3434

3535
```
3636
./gradlew clean buildPlugin
3737
```
3838

3939
The zip file will be in `build/distributions/{plugin_name}-{version}.zip`
4040

41-
To run your code use:
41+
2. Run your code:
4242

4343
```
4444
./gradlew clean runIde
4545
```
4646

4747
## **Installation**
4848

49-
We will let this plugin available in JetBrains Marketplace, but if you want to install through the zip file check this:
50-
[IntelliJ install plugin from the disk](https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk)
49+
This plugin is available on JetBrains Marketplace, but if you can also install it through the zip file, see below:
50+
- [**Install IntelliJ plugin from the disk**](https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk)
5151

5252
## **Usage**
5353

@@ -65,8 +65,8 @@ Using StackSpot tool window after project opened:
6565

6666
## **Documentation**
6767

68-
Check our official documentation page to use StackSpot IntelliJ plugin:
69-
[Documentation link](https://docs.stackspot.com/latest/docs/extensions-for-ide/intellij/)
68+
See StackSpot's documentation to learn more about the IntelliJ plugin:
69+
- [**IntelliJ**](https://docs.stackspot.com.br/docs/extensions-for-ide/intellij/)
7070

7171
## **Contributing**
7272

@@ -86,6 +86,4 @@ Please follow the [**Code of Conduct**](https://github.com/stack-spot/stackspot-
8686

8787
## **Other information**
8888

89-
### **IntelliJ Plugin SDK documentation**
90-
91-
- https://plugins.jetbrains.com/docs/intellij/welcome.html
89+
- [**IntelliJ Plugin SDK documentation**](https://plugins.jetbrains.com/docs/intellij/welcome.html)

0 commit comments

Comments
 (0)