Skip to content

Commit f9d6f3a

Browse files
committed
Update readme
Remove TODO. Rename
1 parent f43baab commit f9d6f3a

File tree

2 files changed

+21
-20
lines changed

2 files changed

+21
-20
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Keep a Changelog guide -> https://keepachangelog.com -->
22

3-
# AvaJavaScriptTestRunnerRunConfigurationGenerator Changelog
3+
# AVA Test Run Configuration Generator Changelog
44

55
## [1.3]
66

README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,40 @@
1-
# AvaJavaScriptTestRunnerRunConfigurationGenerator
1+
# AVA Test Run Configuration Generator
22

33
![Build](https://github.com/eirikb/AvaJavaScriptTestRunnerRunConfigurationGenerator/workflows/Build/badge.svg)
44
[![Version](https://img.shields.io/jetbrains/plugin/v/13835.svg)](https://plugins.jetbrains.com/plugin/13835)
55
[![Downloads](https://img.shields.io/jetbrains/plugin/d/13835.svg)](https://plugins.jetbrains.com/plugin/13835)
66

7-
## Template ToDo list
8-
- [x] Create a new [IntelliJ Platform Plugin Template][template] project.
9-
- [ ] Verify the [pluginGroup](/gradle.properties), [plugin ID](/src/main/resources/META-INF/plugin.xml) and [sources package](/src/main/kotlin).
10-
- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html).
11-
- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time.
12-
- [ ] Set the Plugin ID in the above README badges.
13-
- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html).
14-
- [ ] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes.
157

168
<!-- Plugin description -->
17-
This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have.
18-
19-
This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process.
20-
21-
To keep everything working, do not remove `<!-- ... -->` sections.
9+
<h1>Generates a run configuration for AVA JavaScript test runner</h1>
10+
<p>
11+
This is a workaround while we wait for proper AVA support, see
12+
<a href="https://youtrack.jetbrains.com/issue/WEB-21788">https://youtrack.jetbrains.com/issue/WEB-21788</a>.<br/>
13+
</p>
14+
<h3>Usage</h3>
15+
<p>
16+
Place caret inside a test and press <kbd>ctrl</kbd> + <kbd>alt</kbd> + <kbd>shift</kbd> + <kbd>a</kbd>. <br/>
17+
This should generate and start a new run configuration. <br/>
18+
If caret is outside of a test it should generate and start a run configuration for the file. <br/>
19+
</p>
2220
<!-- Plugin description end -->
2321

2422
## Installation
2523

2624
- Using IDE built-in plugin system:
27-
28-
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "AvaJavaScriptTestRunnerRunConfigurationGenerator"</kbd> >
25+
26+
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "
27+
AVA Test Run Configuration Generator Changelog
28+
"</kbd> >
2929
<kbd>Install Plugin</kbd>
30-
30+
3131
- Manually:
3232

33-
Download the [latest release](https://github.com/eirikb/AvaJavaScriptTestRunnerRunConfigurationGenerator/releases/latest) and install it manually using
33+
Download
34+
the [latest release](https://github.com/eirikb/AvaJavaScriptTestRunnerRunConfigurationGenerator/releases/latest) and
35+
install it manually using
3436
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
3537

36-
3738
---
3839
Plugin based on the [IntelliJ Platform Plugin Template][template].
3940

0 commit comments

Comments
 (0)