Skip to content

Commit f0a49dc

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents 318cf38 + 04b00a7 commit f0a49dc

File tree

1 file changed

+45
-2
lines changed

1 file changed

+45
-2
lines changed

README.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
<h1 align="center">HtmlToComposeWebConverter</h1>
22
Intellij Idea Plugin that can convert HTML to Compose for Web code.
33

4+
Turn this:
5+
<p align="center">
6+
<img src ="https://raw.githubusercontent.com/Foso/HtmlToComposeWebConverter/blob/master/docs/buttonhtml.png" height=500 />
7+
</p>
8+
9+
Into this:
10+
<p align="center">
11+
<img src ="https://raw.githubusercontent.com/Foso/HtmlToComposeWebConverter/blob/master/docs/composebutton.png" height=500 />
12+
</p>
413

514
[![jCenter](https://img.shields.io/badge/Apache-2.0-green.svg
615
)](https://github.com/Foso/HtmlToComposeWebConverter/blob/master/LICENSE)
@@ -12,9 +21,43 @@ Intellij Idea Plugin that can convert HTML to Compose for Web code.
1221

1322
[![GitHub stars](https://img.shields.io/github/stars/Foso/HtmlToComposeWebConverter.svg?style=social&label=Star)](https://github.com/Foso/HtmlToComposeWebConverter) [![GitHub forks](https://img.shields.io/github/forks/Foso/HtmlToComposeWebConverter.svg?style=social&label=Fork)](https://github.com/Foso/HtmlToComposeWebConverter/fork) [![GitHub watchers](https://img.shields.io/github/watchers/Foso/HtmlToComposeWebConverter.svg?style=social&label=Watch)](https://github.com/Foso/HtmlToComposeWebConverter) [![Twitter Follow](https://img.shields.io/twitter/follow/jklingenberg_.svg?style=social)](https://twitter.com/jklingenberg_)
1423

15-
## Introduction
24+
## Introduction / HOW TO USE
25+
26+
1) Put your cursor to the place where you want to insert the Compose code.
27+
2) Open the Plugin under Tools> HTML to Compose Web
28+
<p align="center">
29+
<img src ="https://raw.githubusercontent.com/Foso/HtmlToComposeWebConverter/blob/master/docs/ideatools.png" height=500 />
30+
</p>
31+
3) Add your HTML to press "Generate"
32+
<p align="center">
33+
<img src ="https://raw.githubusercontent.com/Foso/HtmlToComposeWebConverter/blob/master/docs/ideaWindow.png" height=500 />
34+
</p>
35+
4) Your code is now inserted at your cursor.
36+
37+
38+
## :arrow_down:&nbsp;How to install?
39+
40+
You can install plugin directly from IntelliJ IDEA or Android Studio:
41+
1. Open _Preferences_
42+
2. Choose _Plugins_
43+
3. Select the _Marketplace_ tab
44+
4. Search for **HtmlToComposeWebConverter**
45+
5. Click on _install_
46+
47+
Alternativly you can download the plugin from the release archive https://github.com/Foso/HtmlToComposeWebConverter/releases. To learn how to install it, read the [Install plugin from disk](https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk) section in the IntelliJ docs.
48+
49+
## :card_file_box:&nbsp;How can I contribute to this plugin?
50+
51+
* Create a [bug report](https://github.com/Foso/HtmlToComposeWebConverter/issues/new?assignees=&labels=bug&template=i-encountered-a-bug-while-using-the-plugin.md&title=) when accounting a bug
52+
* Create a [feature request](https://github.com/Foso/HtmlToComposeWebConverter/issues/new?assignees=&labels=enhancement&template=i-d-like-to-request-a-feature.md&title=)
53+
* Open up a [pull request](https://github.com/Foso/HtmlToComposeWebConverter/pulls)
1654

55+
## :fire:&nbsp;What's new?
1756

57+
### 1.0.0
58+
<ul>
59+
<li>initial release</li>
60+
</ul>
1861

1962
# 🏠 Architecture
2063

@@ -26,7 +69,7 @@ Intellij Idea Plugin that can convert HTML to Compose for Web code.
2669

2770

2871
### Project Structure
29-
* <kbd>converter/main</kbd> - Module with the converter
72+
* <kbd>converter</kbd> - Module with the converter
3073
* <kbd>ideaplugin</kbd> - Module with the Idea Plugin that is using the converter
3174

3275
## ✍️ Feedback

0 commit comments

Comments
 (0)