Skip to content

Commit 5d085cf

Browse files
committed
Update README.md.
1 parent 62cabde commit 5d085cf

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
[![Ubuntu build][ubuntu-build-badge]][gh-actions]
22
[![license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
3-
# Chords-Gradle-plugin
3+
# Spine Chords Gradle plugin
44

5-
Gradle plugin for [Spine Chords](https://github.com/SpineEventEngine/Chords/)
6-
library that generates Kotlin extensions for Proto messages.
5+
Gradle plugin for [Spine Chords](https://github.com/SpineEventEngine/Chords/),
6+
a suite of libraries for developing desktop UI using the Compose Multiplatform toolkit.
7+
Being based on the [Spine Event Engine](https://spine.io/), the Chords libraries use
8+
the [Protobuf](https://protobuf.dev/) to define the project's model. The Gradle plugin
9+
is designed to generate code that helps to utilize the Protobuf message API, generated by Protobuf
10+
compiler, and exposes its own API, allowing for more flexible and generic way of handling
11+
Protobuf messages.
712

8-
The following code will be generated if the plugin is applied to a project:
13+
So, the following code will be generated if the plugin is applied to a project:
914

1015
- [MessageDef](https://github.com/SpineEventEngine/Chords/blob/master/codegen/runtime/src/main/kotlin/io/spine/chords/runtime/MessageDef.kt)
1116
implementations for Proto messages.
@@ -21,6 +26,10 @@ that returns the instance of `MessageDef` implementation for the current message
2126
- Gradle `6.9.x`
2227
- Kotlin `1.8.20`
2328

29+
The supported Gradle version is chosen because the Chords libraries are currently
30+
based on Spine `1.9.x`, which requires that Gradle version.
31+
Support for newer Gradle versions is expected to increase as new versions of Spine are released.
32+
2433
## How it works
2534

2635
Actually, the plugin applies [codegen-plugins](https://github.com/SpineEventEngine/Chords/blob/master/codegen/plugins/README.md)

0 commit comments

Comments
 (0)