Skip to content

Commit 0fb0d74

Browse files
committed
- reword parts of the README to make it more concise
1 parent 8343d17 commit 0fb0d74

File tree

1 file changed

+30
-22
lines changed

1 file changed

+30
-22
lines changed

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -45,30 +45,35 @@
4545

4646
### Using Gradle
4747

48+
Choose the appropriate configuration based on your project type:
49+
4850
<details open><summary><b>Multiplatform</b></summary>
4951
<p>
5052

51-
For multiplatform projects specify this single dependency:
53+
For multiplatform projects, add these dependencies to your `build.gradle.kts`:
5254

5355
```kotlin
5456
dependencies {
57+
// Core library
5558
implementation("com.mikepenz:multiplatform-markdown-renderer:${version}")
5659

57-
// Offers Material 2 defaults for Material 2 themed apps (com.mikepenz.markdown.m2.Markdown)
60+
// Choose ONE of the following based on your Material theme:
61+
62+
// For Material 2 themed apps
5863
implementation("com.mikepenz:multiplatform-markdown-renderer-m2:${version}")
5964

60-
// Offers Material 3 defaults for Material 3 themed apps (com.mikepenz.markdown.m3.Markdown)
65+
// OR for Material 3 themed apps
6166
implementation("com.mikepenz:multiplatform-markdown-renderer-m3:${version}")
6267
}
6368
```
6469

6570
</p>
6671
</details>
6772

68-
<details><summary><b>JVM</b></summary>
73+
<details><summary><b>JVM (Desktop)</b></summary>
6974
<p>
7075

71-
To use the library on JVM, you have to include:
76+
For JVM-only projects, add this dependency:
7277

7378
```kotlin
7479
dependencies {
@@ -82,7 +87,7 @@ dependencies {
8287
<details><summary><b>Android</b></summary>
8388
<p>
8489

85-
For Android a special dependency is available:
90+
For Android-only projects, add this dependency:
8691

8792
```kotlin
8893
dependencies {
@@ -93,10 +98,9 @@ dependencies {
9398
</p>
9499
</details>
95100

96-
> [!TIP]
97-
> Since 0.13.0 the core library does not depend on a Material theme anymore. Include the `-m2`
98-
> or `-m3` module to get
99-
> access to the defaults.
101+
> [!IMPORTANT]
102+
> Since version 0.13.0, the core library does not depend on a Material theme. You must include
103+
> either the `-m2` or `-m3` module to get access to the default styling.
100104
101105

102106
-------
@@ -440,11 +444,17 @@ Markdown(
440444
)
441445
```
442446

443-
## Dependency
447+
## Dependencies
448+
449+
This library uses the following key dependencies:
444450

445-
This project uses JetBrains [markdown](https://github.com/JetBrains/markdown/) Multiplatform
446-
Markdown processor as
447-
dependency to parse the markdown content.
451+
- [JetBrains Markdown](https://github.com/JetBrains/markdown/) - Multiplatform Markdown processor
452+
for parsing markdown content
453+
- [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform) - For cross-platform
454+
UI rendering
455+
- [Extended Spans](https://github.com/saket/extended-spans) - For advanced text styling (integrated
456+
as multiplatform)
457+
- [Highlights](https://github.com/SnipMeDev/Highlights) - For code syntax highlighting (optional)
448458

449459
## Developed By
450460

@@ -454,9 +464,8 @@ dependency to parse the markdown content.
454464

455465
## Contributors
456466

457-
This free, open source software was also made possible by a group of volunteers that put many hours
458-
of hard work into
459-
it. See the [CONTRIBUTORS.md](CONTRIBUTORS.md) file for details.
467+
This free, open source software was made possible by a group of volunteers who put many hours of
468+
hard work into it. See the [CONTRIBUTORS.md](CONTRIBUTORS.md) file for details.
460469

461470
## Credits
462471

@@ -465,16 +474,15 @@ on [Rendering Markdown with Jetpack Compose](https://www.hellsoft.se/rendering-m
465474
and the related source [MarkdownComposer](https://github.com/ErikHellman/MarkdownComposer).
466475

467476
Also huge thanks to [Saket Narayan](https://github.com/saket/) for his great work on
468-
the [extended-spans](https://github.com/saket/extended-spans) project. Ported into this project to
469-
make it multiplatform.
477+
the [extended-spans](https://github.com/saket/extended-spans) project, which was ported into this
478+
project to make it multiplatform.
470479

471480
## Fork License
472481

473482
Copyright for portions of the code are held by [Erik Hellman, 2020] as part of
474483
project [MarkdownComposer](https://github.com/ErikHellman/MarkdownComposer) under the MIT license.
475-
All other copyright
476-
for project multiplatform-markdown-renderer are held by [Mike Penz, 2023] under the Apache License,
477-
Version 2.0.
484+
All other copyright for project multiplatform-markdown-renderer are held by [Mike Penz, 2023] under
485+
the Apache License, Version 2.0.
478486

479487
## License
480488

0 commit comments

Comments
 (0)