Skip to content

Commit

Permalink
Add snapshot to docs FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
MohamedRejeb committed May 11, 2024
1 parent 58e1d2e commit 49ef9fc
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# FAQ

Have a question that isn't part of the FAQ? Open an issue here [Compose-Rich-Editor](https://github.com/MohamedRejeb/Compose-Rich-Editor/issues).

## How do I get development snapshots?

Add the snapshots repository to your list of repositories in `build.gradle.kts`:

```kotlin
allprojects {
repositories {
maven("https://oss.sonatype.org/content/repositories/snapshots")
}
}
```

Or to your dependency resolution management in `settings.gradle.kts`:

```kotlin
dependencyResolutionManagement {
repositories {
maven("https://s01.oss.sonatype.org/content/repositories/snapshots")
}
}
```

Use the snapshot version:

```kotlin
implementation("com.mohamedrejeb.richeditor:richeditor-compose:1.0.0-SNAPSHOT")
```

>Note: Snapshots are deployed for each new commit on `main` that passes CI. They can potentially contain breaking changes or may be unstable. Use at your own risk.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ nav:
- 'Ordered/Unordered lists': ordered_unordered_lists.md
- 'HTML import/export': html_import_export.md
- 'Markdown import/export': markdown_import_export.md
- 'FAQ': faq.md
#- 'Compose Components': compose.md
- 'Upgrading from 0.x to 1.x': upgrading.md
#- 'Change Log': changelog.md
Expand Down

0 comments on commit 49ef9fc

Please sign in to comment.