Skip to content

Commit c7bc074

Browse files
committed
chore: update readme
1 parent 066b672 commit c7bc074

File tree

1 file changed

+35
-22
lines changed

1 file changed

+35
-22
lines changed

README.md

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,42 @@
1-
# tempest-phpstorm-plugin
1+
# Tempest PHP framework Plugin
22

33
![Build](https://github.com/tempestphp/tempest-phpstorm-plugin/workflows/Build/badge.svg)
4-
[![Version](https://img.shields.io/jetbrains/plugin/v/MARKETPLACE_ID.svg)](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID)
5-
[![Downloads](https://img.shields.io/jetbrains/plugin/d/MARKETPLACE_ID.svg)](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID)
6-
7-
## Template ToDo list
8-
- [x] Create a new [IntelliJ Platform Plugin Template][template] project.
9-
- [ ] Get familiar with the [template documentation][template].
10-
- [ ] Adjust the [pluginGroup](./gradle.properties) and [pluginName](./gradle.properties), as well as the [id](./src/main/resources/META-INF/plugin.xml) and [sources package](./src/main/kotlin).
11-
- [ ] Adjust the plugin description in `README` (see [Tips][docs:plugin-description])
12-
- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html?from=IJPluginTemplate).
13-
- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time.
14-
- [ ] Set the `MARKETPLACE_ID` in the above README badges. You can obtain it once the plugin is published to JetBrains Marketplace.
15-
- [ ] Set the [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate) related [secrets](https://github.com/JetBrains/intellij-platform-plugin-template#environment-variables).
16-
- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html?from=IJPluginTemplate).
17-
- [ ] 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.
18-
- [ ] Configure the [CODECOV_TOKEN](https://docs.codecov.com/docs/quick-start) secret for automated test coverage reports on PRs
4+
[![Version](https://img.shields.io/jetbrains/plugin/v/28504-tempest-php.svg)](https://plugins.jetbrains.com/plugin/28504-tempest-php)
5+
[![Downloads](https://img.shields.io/jetbrains/plugin/d/28504-tempest-php.svg)](https://plugins.jetbrains.com/plugin/28504-tempest-php)
196

207
<!-- Plugin description -->
21-
This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have.
228

23-
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.
9+
[Github](https://github.com/tempestphp/tempest-phpstorm-plugin) | [Documentation](https://tempestphp.com/2.x/getting-started/introduction) | [Discord](https://discord.com/invite/pPhpTGUMPQ)
10+
11+
## Tempest PHP framework support.
12+
13+
### The framework that gets out of your way.
14+
Tempest embraces modern PHP and covers a wide range of features, giving you all the tools you need to focus on your code.
15+
16+
## Quickstart
17+
18+
```bash
19+
composer create-project tempest/app
20+
```
21+
22+
## Features
23+
24+
> [!TIP]
25+
> It's recommended to disable Vue plugin to make Tempest work properly with template files
26+
27+
- [ ] Templates files intentions (partially)
28+
-- [x] Components names as tag names
29+
-- [x] String interpolation in templates
30+
-- [x] Hyper-properties in tag attributes
31+
-- [ ] PHP code in templates (partially)
32+
- [x] Console commands runner
33+
- [ ] Routes support
34+
- [ ] Database support
35+
- [ ] Events support
36+
- [ ] Jobs support
37+
- [ ] Mail support
38+
- [ ] Tests support
2439

25-
To keep everything working, do not remove `<!-- ... -->` sections.
2640
<!-- Plugin description end -->
2741

2842
## Installation
@@ -34,9 +48,9 @@ To keep everything working, do not remove `<!-- ... -->` sections.
3448

3549
- Using JetBrains Marketplace:
3650

37-
Go to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID) and install it by clicking the <kbd>Install to ...</kbd> button in case your IDE is running.
51+
Go to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/28504-tempest-php) and install it by clicking the <kbd>Install to ...</kbd> button in case your IDE is running.
3852

39-
You can also download the [latest release](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID/versions) from JetBrains Marketplace and install it manually using
53+
You can also download the [latest release](https://plugins.jetbrains.com/plugin/28504-tempest-php/versions) from JetBrains Marketplace and install it manually using
4054
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
4155

4256
- Manually:
@@ -49,4 +63,3 @@ To keep everything working, do not remove `<!-- ... -->` sections.
4963
Plugin based on the [IntelliJ Platform Plugin Template][template].
5064

5165
[template]: https://github.com/JetBrains/intellij-platform-plugin-template
52-
[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation

0 commit comments

Comments
 (0)