Finishing a revamp of the readme

Author: PGMacDesign2

README.md

@@ -18,9 +18,9 @@ publishing {
 
         // Provide artifacts information required by Maven Central
         pom {
-            name.set("Compose Rich Editor")
-            description.set("A Compose multiplatform library that provides a rich text editor.")
-            url.set("https://github.com/MohamedRejeb/Compose-Rich-Editor")
+            name.set("Compose Rich Editor with @ Mentions")
+            description.set("A Compose multiplatform rich text editor with advanced @ mention functionality and Lexical JSON compatibility.")
+            url.set("https://github.com/Kajabi/Android-Kajabi-Rich-Text")
 
             licenses {
                 license {
@@ -30,23 +30,26 @@ publishing {
             }
             issueManagement {
                 system.set("Github")
-                url.set("https://github.com/MohamedRejeb/Compose-Rich-Editor/issues")
+                url.set("https://github.com/Kajabi/Android-Kajabi-Rich-Text/issues")
             }
             scm {
-                connection.set("https://github.com/MohamedRejeb/Compose-Rich-Editor.git")
-                url.set("https://github.com/MohamedRejeb/Compose-Rich-Editor")
+                connection.set("https://github.com/Kajabi/Android-Kajabi-Rich-Text.git")
+                url.set("https://github.com/Kajabi/Android-Kajabi-Rich-Text")
             }
             developers {
                 developer {
-                    id.set("MohamedRejeb")
-                    name.set("Mohamed Rejeb")
-                    email.set("mohamedrejeb445@gmail.com")
+                    id.set("PGMacDesign")
+                    name.set("Patrick MacDowell")
+                    email.set("patrick.macdowell@kajabi.com")
                 }
             }
         }
     }
 }
 
+// For JitPack, signing is optional and can cause issues
+// Comment out the signing configuration for JitPack
+/*
 signing {
     useInMemoryPgpKeys(
         System.getenv("OSSRH_GPG_SECRET_KEY_ID"),
@@ -59,4 +62,5 @@ signing {
 // TODO: remove after https://youtrack.jetbrains.com/issue/KT-46466 is fixed
 project.tasks.withType(AbstractPublishToMaven::class.java).configureEach {
     dependsOn(project.tasks.withType(Sign::class.java))
-}
+}
+*/

convention-plugins/src/main/kotlin/module.publication.gradle.kts

@@ -3,20 +3,7 @@ plugins {
 }
 
 allprojects {
-    group = "com.mohamedrejeb.richeditor"
-    version = System.getenv("VERSION") ?: "1.0.0-rc12"
+    group = "com.github.Kajabi"
+    version = System.getenv("VERSION") ?: "1.0.0-mentions-alpha01"
 }
 
-nexusPublishing {
-    // Configure maven central repository
-    // https://github.com/gradle-nexus/publish-plugin#publishing-to-maven-central-via-sonatype-ossrh
-    repositories {
-        sonatype {
-            nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/"))
-            snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/"))
-            stagingProfileId.set(System.getenv("OSSRH_STAGING_PROFILE_ID"))
-            username.set(System.getenv("OSSRH_USERNAME"))
-            password.set(System.getenv("OSSRH_PASSWORD"))
-        }
-    }
-}

convention-plugins/src/main/kotlin/root.publication.gradle.kts

@@ -0,0 +1,78 @@
+# Android Rich Text Editor with @ Mentions - Release 1.0.0-mentions-alpha01
+
+## AAR Files Included
+
+### Main Library
+- **File**: `richeditor-compose-release.aar` (532 KB)
+- **Description**: Core rich text editor library with @ mentions functionality
+- **Contains**: All rich text editing features, @ mention support, Lexical JSON compatibility
+
+### Coil3 Extension  
+- **File**: `richeditor-compose-coil3-release.aar` (6.4 KB)
+- **Description**: Coil3 image loading integration for @ mention avatars
+- **Contains**: Image loading utilities for user profile pictures in mentions
+
+## Usage
+
+### Option 1: JitPack (Recommended)
+```kotlin
+repositories {
+    maven { url = uri("https://jitpack.io") }
+}
+
+dependencies {
+    // Main library with @ mentions support
+    implementation("com.github.Kajabi:Android-Kajabi-Rich-Text:1.0.0-mentions-alpha01")
+    
+    // For avatar image loading in mentions
+    implementation("io.coil-kt.coil3:coil-compose:3.1.0")
+}
+```
+
+### Option 2: Local AAR Files
+```kotlin
+dependencies {
+    // Place AAR files in app/libs/ directory
+    implementation(files("libs/richeditor-compose-release.aar"))
+    implementation(files("libs/richeditor-compose-coil3-release.aar"))
+    
+    // Required dependencies
+    implementation("io.coil-kt.coil3:coil-compose:3.1.0")
+    implementation("androidx.compose.ui:ui:1.8.0-alpha03")
+    implementation("androidx.compose.material3:material3:1.8.0-alpha03")
+}
+```
+
+## Integration
+
+Replace your existing rich text editor with the mentions-enabled version:
+
+```kotlin
+// Instead of RichTextEditor
+KJRichTextEditorWithMentions(
+    state = richTextState,
+    users = yourUserList, // List<MentionUser>
+    placeholder = { Text("Type a message...") }
+)
+```
+
+## Features Included
+
+- ✅ **@ Mention Autocomplete**: Type `@` + name for filtered suggestions
+- ✅ **Atomic Mention Behavior**: Mentions can only be deleted entirely
+- ✅ **Avatar Support**: User profile pictures with Coil3 image loading
+- ✅ **Rich Text Formatting**: Bold, italic, underline, strikethrough, headings
+- ✅ **List Support**: Ordered/unordered lists with indentation
+- ✅ **Lexical JSON Compatibility**: Full import/export support
+- ✅ **Cross-Platform**: Android, Desktop, iOS, JS, WASM support
+
+## Version Info
+
+- **Version**: 1.0.0-mentions-alpha01
+- **Build Date**: June 27, 2024
+- **Group ID**: com.github.Kajabi
+- **Repository**: https://github.com/Kajabi/Android-Kajabi-Rich-Text
+
+## Support
+
+For issues and questions, visit: https://github.com/Kajabi/Android-Kajabi-Rich-Text/issues 

adding_at_mentions_support.md docs/adding_at_mentions_support.mdadding_at_mentions_support.md renamed to docs/adding_at_mentions_support.md

@@ -15,10 +15,6 @@ import com.mohamedrejeb.richeditor.ui.material3.RichText
 @OptIn(ExperimentalMaterial3Api::class, ExperimentalLayoutApi::class)
 @Composable
 fun HomeScreen(
-    navigateToRichEditor: () -> Unit,
-    navigateToHtmlEditor: () -> Unit,
-    navigateToMarkdownEditor: () -> Unit,
-    navigateToSlack: () -> Unit,
     navigateToKjCommunitiesSlack: () -> Unit,
 ) {
     val richTextState = rememberRichTextState()
@@ -63,38 +59,6 @@ fun HomeScreen(
                 Spacer(modifier = Modifier.height(20.dp))
             }
 
-            item {
-                Button(
-                    onClick = navigateToRichEditor,
-                ) {
-                    Text("Rich Text Editor Demo")
-                }
-            }
-
-            item {
-                Button(
-                    onClick = navigateToHtmlEditor,
-                ) {
-                    Text("HTML Editor Demo")
-                }
-            }
-
-            item {
-                Button(
-                    onClick = navigateToMarkdownEditor,
-                ) {
-                    Text("Markdown Editor Demo")
-                }
-            }
-
-            item {
-                Button(
-                    onClick = navigateToSlack,
-                ) {
-                    Text("Slack Clone Demo")
-                }
-            }
-
             item {
                 Button(
                     onClick = navigateToKjCommunitiesSlack,

release/RELEASE_INFO.md

@@ -5,17 +5,9 @@ import androidx.navigation.compose.NavHost
 import androidx.navigation.compose.composable
 import androidx.navigation.compose.rememberNavController
 import com.mohamedrejeb.richeditor.sample.common.home.HomeScreen
-import com.mohamedrejeb.richeditor.sample.common.htmleditor.HtmlEditorContent
-import com.mohamedrejeb.richeditor.sample.common.markdowneditor.MarkdownEditorContent
-import com.mohamedrejeb.richeditor.sample.common.richeditor.RichEditorScreen
-import com.mohamedrejeb.richeditor.sample.common.slack.SlackDemoScreen
 import com.kjcommunities.KJDemoScreen as KjCommunitiesKJDemoScreen
 
 private const val HOME_ROUTE = "home"
-private const val RICH_EDITOR_ROUTE = "richEditor"
-private const val HTML_EDITOR_ROUTE = "htmlEditor"
-private const val MARKDOWN_EDITOR_ROUTE = "markdownEditor"
-private const val SLACK_ROUTE = "slack"
 private const val KJCOMMUNITIES_SLACK_ROUTE = "kjcommunitiesSlack"
 
 @Composable
@@ -28,38 +20,10 @@ fun NavGraph() {
     ) {
         composable(HOME_ROUTE) {
             HomeScreen(
-                navigateToRichEditor = { navController.navigate(RICH_EDITOR_ROUTE) },
-                navigateToHtmlEditor = { navController.navigate(HTML_EDITOR_ROUTE) },
-                navigateToMarkdownEditor = { navController.navigate(MARKDOWN_EDITOR_ROUTE) },
-                navigateToSlack = { navController.navigate(SLACK_ROUTE) },
                 navigateToKjCommunitiesSlack = { navController.navigate(KJCOMMUNITIES_SLACK_ROUTE) }
             )
         }
 
-        composable(RICH_EDITOR_ROUTE) {
-            RichEditorScreen(
-                navigateBack = { navController.popBackStack() }
-            )
-        }
-
-        composable(HTML_EDITOR_ROUTE) {
-            HtmlEditorContent(
-                navigateBack = { navController.popBackStack() }
-            )
-        }
-
-        composable(MARKDOWN_EDITOR_ROUTE) {
-            MarkdownEditorContent(
-                navigateBack = { navController.popBackStack() }
-            )
-        }
-
-        composable(SLACK_ROUTE) {
-            SlackDemoScreen(
-                navigateBack = { navController.popBackStack() }
-            )
-        }
-
         composable(KJCOMMUNITIES_SLACK_ROUTE) {
             KjCommunitiesKJDemoScreen(
                 navigateBack = { navController.popBackStack() }