Skip to content

Commit f0869a3

Browse files
committed
Updated README.md
1 parent c222b78 commit f0869a3

File tree

3 files changed

+14
-22
lines changed

3 files changed

+14
-22
lines changed

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
## Kotlin Multiplatform SoundFont library
3-
[![Kotlin](https://img.shields.io/badge/kotlin-2.0.21-blue.svg?logo=kotlin)](http://kotlinlang.org)
3+
[![Kotlin](https://img.shields.io/badge/kotlin-2.1.0-blue.svg?logo=kotlin)](http://kotlinlang.org)
44
[![GitHub License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
55
>:warning: This library is NOT ready for production use.:warning:
66
@@ -18,32 +18,21 @@ Non goals:
1818

1919

2020
Platform support:
21-
| Android |iOS | Mingw X64 | Linux X64 |
22-
|--|--|--|--|
23-
| :heavy_check_mark: | :hourglass: | :heavy_check_mark: | :heavy_check_mark: |
24-
25-
26-
27-
28-
___
29-
### Features
30-
This library is in early stage. Full set of features as well as documentation is yet to be released.
31-
32-
21+
| Android |iOS | Mingw X64 | Linux X64 | MacOs | Wasm | JS |
22+
|--|--|--|--|--|--|--|
23+
|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|:hourglass:|:heavy_multiplication_x:|
3324

3425
___
3526
### Installation
36-
>:warning: This library is not YET available on Maven Central :warning:
37-
> For now use the `msf.zip` file provided in [releases](https://github.com/lemcoder/MikroSoundFont/releases/) and unpack it in [local maven repository](https://www.baeldung.com/maven-local-repository).
3827

39-
To add library to Your project paste the following snippet in your TOML file.
28+
This library is stored on Maven Central repository. To add library to Your project paste the following snippet in your TOML file.
4029
```
4130
[versions]
4231
mikrosoundfont = "<latest_version>"
4332
4433
[libraries]
45-
mikrosoundfont-midi = { module = "io.github.lemcoder.mikroSoundFont:midi", version.ref = "mikrosoundfont" }
46-
mikrosoundfont-soundFont = { module = "io.github.lemcoder.mikroSoundFont:soundFont", version.ref = "mikrosoundfont" }
34+
mikrosoundfont-midi = { module = "io.github.lemcoder.mikrosoundfont:midi", version.ref = "mikrosoundfont" }
35+
mikrosoundfont-soundFont = { module = "io.github.lemcoder.mikrosoundfont:soundFont", version.ref = "mikrosoundfont" }
4736
```
4837
___
4938
### Usage
@@ -62,7 +51,10 @@ val audioBytes = MidiSequencer(soundFont, 44_100).apply {
6251
// use audioBytes (e.g. write to .wav file)
6352
```
6453

65-
___
54+
## License
55+
56+
This project is licensed under the Apache 2.0 License - see the [LICENSE.md](LICENSE.md) file for details
57+
6658

6759
### Useful resources:
6860
* [Sandard MIDI files specification](https://drive.google.com/file/d/1t4jcCCKoi5HMi7YJ6skvZfKcefLhhOgU/view?u)

gradle/libs.versions.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[versions]
2-
lib = "0.1.5"
2+
lib = "0.1.6"
33

44
agp = "8.7.2"
55
kotlin = "2.1.0"

midi/build.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ plugins {
88
signing
99
}
1010

11-
group = "io.github.lemcoder.mikroSoundFont"
11+
group = "io.github.lemcoder.mikrosoundfont"
1212
version = libs.versions.lib.get().toString()
1313

1414
android {
15-
namespace = "io.github.lemcoder.mikroSoundFont"
15+
namespace = "io.github.lemcoder.mikrosoundfont"
1616
defaultConfig {
1717
compileSdk = libs.versions.android.compileSdk.get().toInt()
1818
minSdk = libs.versions.android.minSdk.get().toInt()

0 commit comments

Comments
 (0)