Skip to content

Commit

Permalink
Updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
daviddenton committed Sep 2, 2024
1 parent 380b936 commit 19d0ec9
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 3 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
# http4k Project Wizard IntelliJ Plugin
<hr/>
<img src="logo.png">
<hr/>

<p align="center">
<a href="https://plugins.jetbrains.com/plugin/25243-http4k-project-wizard"><img src="install.png" width="25%"></a>
</p>

This plugin generates boilerplate http4k-based projects with ease by integrating a project wizard into IntelliJ IDEA. It streamlines the process of creating new
http4k projects by providing a user-friendly interface within the IDE and access to the [http4k Toolbox](https://toolbox.http4k.org).

<img src="screenshot.png">
<p align="center">
<img src="screenshot.png" width="70%">
</p>

### How to use

Simply create a new IntelliJ project and select the http4k option from the left panel. The Wizard will guide you through a set of questions which will allow you
to select a bunch of modules from the http4k ecosystem, including build tooling.

The generated project will be fully functional, including template tests and a run configuration for the main application class.
Binary file added install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
</change-notes>

<description><![CDATA[
Wizard for <a href="https://http4k.org">http4k</a> based projects. Configures the project with the necessary dependencies and settings.
This plugin generates boilerplate <a href="https://http4k.org>http4k</a> based projects with ease by integrating a project wizard into IntelliJ IDEA. It streamlines the process of creating new
http4k projects by providing a user-friendly interface within the IDE and access to the <a href="https://toolbox.http4k.org>http4k Toolbox</a>>.
]]></description>

<depends>com.intellij.modules.java</depends>
Expand Down

0 comments on commit 19d0ec9

Please sign in to comment.