Skip to content
This repository was archived by the owner on Oct 9, 2021. It is now read-only.

Commit 0005282

Browse files
authored
Added a settings section in the README.md (#120)
1 parent 45c363a commit 0005282

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,41 @@ Json2Java4Idea
88
## Table of Contents
99
* [Background](#background)
1010
* [Installation](#installation)
11+
* [Settings](#settings)
1112
* [Troubleshooting](#troubleshooting)
1213
* [License](#license)
1314

1415
<a name="background"></a>
1516
## Background
16-
There are several JSON Serializing and deserializing library something like Jackson or Gson, and you might use one of these library.<br/>
17+
There are several JSON Serializing and deserializing library something like Jackson or Gson.<br/>
1718
However implementing a class which is converted from JSON is a bored stuff.<br/>
1819
Json2Java4Idea could be a solution for the stuff.<br/>
19-
Also this plugin supports following libraries.<br/>
20+
The plugin generates immutable Java class from JSON and supports following libraries.<br/>
2021
* [Jackson](https://github.com/FasterXML/jackson)
2122
* [GSON](https://github.com/google/gson)
2223
* [Moshi](https://github.com/square/moshi)
2324

2425
<a name="installation"></a>
2526
## Installation
26-
1. Open the **Settings/Preferences** dialog
27+
1. Open the **Settings/Preferences** dialog.
2728
1. In the left pane, select **Plugins**.
2829
1. In the right pane, click the **Browse repositories...** button.
2930
1. In the dialog which opens, enter **Json2Java4Idea** into the search box.
3031
1. In the right pane, click the **Install** button.
3132
1. After installation, restart your IDE.
3233

34+
<a name="settings"></a>
35+
## Settings
36+
1. Open the **Settings/Preferences** dialog.
37+
1. In the left pane, select **Other Settings**.
38+
1. In the right pane, click the **Json2Java4Idea** link.
39+
1. After configuration changing finished, click the **Apply** button.
40+
41+
Currently there are 3 types of settings you can configure.
42+
1. Class style
43+
1. Prefix of class name
44+
1. Suffix of class name
45+
3346
<a name="troubleshooting"></a>
3447
## Troubleshooting
3548
Please [raise an issue](https://github.com/t28hub/json2java4idea/issues/new) on this repository.

0 commit comments

Comments
 (0)