Skip to content

Commit e59501f

Browse files
developerchunkdeveloperchunk
authored
README update
Updated README to reflect platform support and installation instructions for Kotlin Multiplatform. Enhanced descriptions and added new sections for JetCo features and getting started guides.
1 parent bb49b5a commit e59501f

File tree

1 file changed

+151
-27
lines changed

1 file changed

+151
-27
lines changed

‎README.md‎

Lines changed: 151 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,19 @@
11
# **JetCo Library**
22

33
Welcome to the **JetCo** library documentation!
4-
JetCo is your ultimate **Open-Source** partner for crafting visually stunning, interactive, and efficient UI components in Android apps. 💡
5-
Designed specifically for Jetpack Compose enthusiasts, JetCo is here to make your life easier, your apps prettier, and your users happier. 😊
4+
JetCo is a ready-to-go Compose library building awesome UI components for both **Android** and **KMP** (Kotlin Multiplatform). 💡
5+
6+
Your ultimate **Open-Source** partner for crafting visually stunning, interactive, and efficient UI components across multiple platforms including **Android**, **iOS**, **JVM**, **JS**, and **WASM**. Designed specifically for Jetpack Compose enthusiasts, JetCo is here to make your life easier, your apps prettier, and your users happier. 😊
67

78
View the full Documentation of <a href="https://jetco.developerstring.com" target="_blank" rel="noopener noreferrer">JetCo Docs</a>
89

910
<a href="https://github.com/DeveloperChunk/JetCo" target="_blank" rel="noopener noreferrer">![GitHub release (latest by date)](https://img.shields.io/github/v/release/developerchunk/jetco?label=GitHub)</a> <a href="https://central.sonatype.com/artifact/com.developerstring.jetco/ui" target="_blank" rel="noopener noreferrer">![Maven Central](https://img.shields.io/maven-central/v/com.developerstring.jetco/ui.svg?label=Maven%20Central)</a>
1011

1112
---
1213

13-
## 📊 **Supported UI Components**
14-
15-
JetCo offers a growing lineup of UI components that make your apps stand out:
16-
17-
| 🧁 Component | 🍭 Description |
18-
| ----------------------------- | -------------------------------------------------------------------------------------------- |
19-
| **Pie Chart** | Slice and dice your data into a tasty pie chart format. 🥧 |
20-
| **Column Bar Chart** | Perfect for showing data as bars with full customization. 📊 |
21-
| **Extended Column Bar Chart** | Take your bar charts to the next level with advanced features. 🔥 |
22-
| **Group Column Bar Chart** | Compare multiple data sets side by side. 🤓 |
23-
| **TicketCard** | Custom ticket-style card with cutout arcs, dashed dividers, and flexible slots. 🎟️ |
24-
| **VerticalStepper** | A vertical timeline/stepper with titles, descriptions, and optional images in each node. ⬇️ |
25-
| **HorizontalStepper** | A clean and simple horizontal stepper for progress or timeline representation. ➡️ |
26-
| **CompactHorizontalStepper** | A minimal, icon-only horizontal stepper for compact UIs (great for mobile). ⚡ |
27-
| **SwitchButton** | A customizable and animated switch button composable. 🔘 |
28-
29-
---
14+
## 🎨 **JetCo in Action**
3015

31-
Check out the examples below to see JetCo in action!
16+
Check out the examples below to see JetCo's awesome UI components!
3217

3318
<table>
3419
<tr>
@@ -69,14 +54,150 @@ Check out the examples below to see JetCo in action!
6954
</tr>
7055
</table>
7156

57+
---
58+
59+
## 📱 **Platform Support**
60+
61+
JetCo now supports multiple platforms through Kotlin Multiplatform:
62+
63+
| Platform | Support | Description |
64+
|----------|---------|-------------|
65+
| 🤖 **Android** | ✅ | Full support with Android-specific optimizations |
66+
| 🍎 **iOS** | ✅ | Native iOS support through Compose Multiplatform |
67+
| 💻 **JVM** | ✅ | Desktop applications (Windows, macOS, Linux) |
68+
| 🌐 **JS** | ✅ | Web applications with Compose for Web |
69+
| ⚡ **WASM** | ✅ | WebAssembly support for high-performance web apps |
7270

71+
---
72+
73+
## 🚀 **Installation**
74+
75+
### **For Android Projects (Legacy)**
76+
Add this to your module's `build.gradle.kts`:
77+
78+
```kotlin
79+
dependencies {
80+
implementation("com.developerstring.jetco:ui:1.0.0-beta.6")
81+
}
82+
```
83+
84+
### **For Kotlin Multiplatform Projects**
85+
Add this to your `commonMain` dependencies in `build.gradle.kts`:
86+
87+
```kotlin
88+
commonMain.dependencies {
89+
implementation("com.developerstring.jetco-kmp:ui:1.0.0-beta.7")
90+
}
91+
```
92+
93+
### **Complete KMP Setup Example**
94+
95+
```kotlin
96+
kotlin {
97+
androidTarget()
98+
99+
listOf(
100+
iosX64(),
101+
iosArm64(),
102+
iosSimulatorArm64()
103+
).forEach { iosTarget ->
104+
iosTarget.binaries.framework {
105+
baseName = "ComposeApp"
106+
isStatic = true
107+
}
108+
}
109+
110+
jvm("desktop")
111+
112+
js(IR) {
113+
moduleName = "composeApp"
114+
browser {
115+
commonWebpackConfig {
116+
outputFileName = "composeApp.js"
117+
}
118+
}
119+
binaries.executable()
120+
}
121+
122+
wasmJs {
123+
moduleName = "composeApp"
124+
browser {
125+
commonWebpackConfig {
126+
outputFileName = "composeApp.js"
127+
}
128+
}
129+
binaries.executable()
130+
}
131+
132+
sourceSets {
133+
commonMain.dependencies {
134+
implementation(compose.runtime)
135+
implementation(compose.foundation)
136+
implementation(compose.material3)
137+
implementation(compose.ui)
138+
implementation(compose.components.resources)
139+
140+
// Add JetCo KMP
141+
implementation("com.developerstring.jetco-kmp:ui:1.0.0-beta.7")
142+
}
143+
}
144+
}
145+
```
146+
147+
---
148+
149+
## 📊 **Supported UI Components**
73150

151+
JetCo offers a growing lineup of UI components that make your apps stand out:
152+
153+
| 🧁 Component | 🍭 Description |
154+
| ----------------------------- | -------------------------------------------------------------------------------------------- |
155+
| **Pie Chart** | Slice and dice your data into a tasty pie chart format. 🥧 |
156+
| **Column Bar Chart** | Perfect for showing data as bars with full customization. 📊 |
157+
| **Extended Column Bar Chart** | Take your bar charts to the next level with advanced features. 🔥 |
158+
| **Group Column Bar Chart** | Compare multiple data sets side by side. 🤓 |
159+
| **TicketCard** | Custom ticket-style card with cutout arcs, dashed dividers, and flexible slots. 🎟️ |
160+
| **VerticalStepper** | A vertical timeline/stepper with titles, descriptions, and optional images in each node. ⬇️ |
161+
| **HorizontalStepper** | A clean and simple horizontal stepper for progress or timeline representation. ➡️ |
162+
| **CompactHorizontalStepper** | A minimal, icon-only horizontal stepper for compact UIs (great for mobile). ⚡ |
163+
| **SwitchButton** | A customizable and animated switch button composable. 🔘 |
164+
74165
---
75166

76167
## 🚀 **Getting Started**
77168

78169
Want to get started right away? We've got your back! 🏃‍♂️
79-
Head over to the <a href="https://jetco.developerstring.com" target="_blank" rel="noopener noreferrer">JetCo Docs</a> for installation, sample code, and customization guides. ⏱
170+
171+
### **Quick Start with KMP**
172+
```kotlin
173+
@Composable
174+
fun MyAwesomeScreen() {
175+
// Use any JetCo component across all platforms!
176+
PieChart(
177+
data = listOf(
178+
PieChartData("Android", 40f, Color.Green),
179+
PieChartData("iOS", 30f, Color.Blue),
180+
PieChartData("Web", 20f, Color.Red),
181+
PieChartData("Desktop", 10f, Color.Yellow)
182+
)
183+
)
184+
}
185+
```
186+
187+
### **Import Components**
188+
```kotlin
189+
// For KMP projects
190+
import com.developerstring.jetco_kmp.charts.piechart.PieChart
191+
import com.developerstring.jetco_kmp.cards.ticket.TicketCard
192+
import com.developerstring.jetco_kmp.components.stepper.VerticalStepper
193+
194+
// For Android-only projects
195+
import com.developerstring.jetco.ui.charts.piechart.PieChart
196+
import com.developerstring.jetco.ui.cards.ticket.TicketCard
197+
import com.developerstring.jetco.ui.components.stepper.VerticalStepper
198+
```
199+
200+
Head over to the <a href="https://jetco.developerstring.com" target="_blank" rel="noopener noreferrer">JetCo Docs</a> for detailed installation guides, sample code, and customization options for all platforms. ⏱
80201

81202
---
82203

@@ -86,15 +207,18 @@ Head over to the <a href="https://jetco.developerstring.com" target="_blank" rel
86207
* **Fast & lightweight**. Your app stays smooth. 🧈
87208
* **Beautiful & customizable** components.
88209

89-
Whether it’s a hobby project or the next unicorn 🦄 — JetCo helps you craft jaw-dropping UIs.
210+
Whether it's a hobby project or the next unicorn 🦄 — JetCo helps you craft jaw-dropping UIs that work everywhere.
90211

91212
---
92-
## 🎉 **Key Features**
93213

94-
* 🖌 **Modern UI Components:** Charts, ticket cards, and more to bring your app to life.
95-
* ⚡️ **Seamless Jetpack Compose Integration:** Works flawlessly with Compose.
96-
* 🛠 **Customization Galore:** Tune every detail to fit your design.
97-
* 🚀 **Performance Optimized:** Lightweight and blazing fast.
214+
## 🚀 **What Makes JetCo Special?**
215+
216+
* 🌐 **Kotlin Multiplatform Support:** One codebase for Android, iOS, Web, Desktop, and WASM.
217+
* 🖌 **Modern UI Components:** Charts, ticket cards, steppers, and more to bring your app to life.
218+
* ⚡️ **Seamless Compose Integration:** Works flawlessly with Jetpack Compose and Compose Multiplatform.
219+
* 🛠 **Customization Galore:** Tune every detail to fit your design across all platforms.
220+
* 🚀 **Performance Optimized:** Lightweight and blazing fast on every platform.
221+
* 📱 **Platform-Specific Optimizations:** Tailored experiences for each target platform.
98222

99223
---
100224

0 commit comments

Comments
 (0)