Skip to content

Commit 4bee317

Browse files
committed
Update readme and simplify project structure
1 parent da0e982 commit 4bee317

13 files changed

+233
-137
lines changed

CHANGELOG.md

Lines changed: 0 additions & 130 deletions
This file was deleted.

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![JsonToKotlinClass](https://raw.githubusercontent.com/wuseal/JsonToKotlinClass/master/title.png)
1+
![JsonToKotlinClass](https://raw.githubusercontent.com/wuseal/JsonToKotlinClass/master/doc/title.png)
22

33
[![Build Status](https://travis-ci.com/wuseal/JsonToKotlinClass.svg?branch=master&status=started)](https://travis-ci.com/wuseal/JsonToKotlinClass)
44
[![GitHub release](https://img.shields.io/github/release/wuseal/JsonToKotlinClass.svg?style=flat)](https://github.com/wuseal/JsonToKotlinClass/releases)
@@ -13,7 +13,7 @@
1313

1414
# JsonToKotlinClass
1515
Hi, Welcome! This is a plugin to generate Kotlin `data class` from JSON string, in another word, a plugin that converts JSON string to Kotlin `data class` (Json to Kotlin).
16-
We also have a `Java/Kotlin` [library](LIBRARY.md). With this you can generate Kotlin `data class` from JSON string **programmatically**.
16+
We also have a `Java/Kotlin` [library](doc/LIBRARY.md). With this you can generate Kotlin `data class` from JSON string **programmatically**.
1717

1818
```groovy
1919
implementation 'wu.seal.jsontokotlin:library:3.6.1'
@@ -49,7 +49,7 @@ This is a very cool tool for Kotlin developers, it can convert a JSON string to
4949
Have a try with the advanced dialog :stuck_out_tongue_winking_eye:
5050

5151
### Features
52-
* Generating Kotlin data class from any legal JSON string/JSONSchema or any **URLs that returns a JSON string/JSONSchema as response** or **local file that contains JSON string/JSONSchema**, for more detail about supported source types, refer to [the documentation](https://github.com/wuseal/JsonToKotlinClass/blob/master/doc_for_json_sources.md)
52+
* Generating Kotlin data class from any legal JSON string/JSONSchema or any **URLs that returns a JSON string/JSONSchema as response** or **local file that contains JSON string/JSONSchema**, for more detail about supported source types, refer to [the documentation](https://github.com/wuseal/JsonToKotlinClass/blob/master/doc/doc_for_json_sources.md)
5353
* Generating Kotlin data class from any legal JSON text when right click on directory and select `New` -> `Kotlin data class File from JSON`
5454
* Supporting (almostly) all kinds of JSON libs' annotation(Gson, Jackson, Fastjson, MoShi and LoganSquare, kotlinx.serialization(default custom value))
5555
* [Customizing your own annotations](https://github.com/wuseal/JsonToKotlinClass/issues/19)
@@ -64,7 +64,7 @@ Have a try with the advanced dialog :stuck_out_tongue_winking_eye:
6464
* [Android Parcelable support](https://github.com/wuseal/JsonToKotlinClass/issues/194)
6565
* [Customize parent class declaration](https://github.com/wuseal/JsonToKotlinClass/issues/44)
6666
* Generating kotlin data class property order by alphabetical
67-
* [Support customizing this plugin by `Extensions` module](https://github.com/wuseal/JsonToKotlinClass/blob/master/doc_for_extensions.md)
67+
* [Support customizing this plugin by `Extensions` module](https://github.com/wuseal/JsonToKotlinClass/blob/master/doc/doc_for_extensions.md)
6868

6969
### Generate Example
7070
This is the example JSON from json.org
@@ -132,7 +132,9 @@ data class GlossDef(
132132
val para: String
133133
)
134134
```
135-
135+
### Change Log
136+
* [Change log since 3.0.0](doc/CHANGELOG.md)
137+
* [Change log 1.x.x](doc/CHANGELOG_1.X.md)
136138
### Build From Source
137139

138140
Want to try out the newest features?

build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ tasks.getByPath("publishPlugin").dependsOn("generateChangelog")
5353

5454
changelogForIDEPlugin {
5555
version = project.version.toString()
56-
path = "${project.projectDir}/CHANGELOG.md"
56+
path = "${project.projectDir}/doc/CHANGELOG.md"
5757
unreleasedTerm = "Unreleased"
5858
itemPrefix = "**"
5959
}
@@ -82,5 +82,5 @@ changelog {
8282
useMilestoneAsTag = true
8383
timezone = DEFAULT_TIMEZONE
8484

85-
outputFile = file("${projectDir}/CHANGELOG.md")
85+
outputFile = file("${projectDir}/doc/CHANGELOG.md")
8686
}

0 commit comments

Comments
 (0)