diff --git a/docs/index.md b/docs/index.md index f34ec745..0bcc436d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,6 +6,10 @@ Inspired from [Flipper](https://github.com/facebook/flipper) by Meta, while leve It allows developers to connect a Kotlin Multiplatform or Android app to their computer and launch a **desktop interface** that can **observe, inspect, and interact with the running app** in real time β€” across shared Kotlin code and platform-specific implementations. +Screenshot 2025-09-12 at 15 39 45 + +----> [Getting Started](setup.md) <---- + **Works on** @@ -104,18 +108,4 @@ With Flocon, you gain deep access to critical app internals β€” such as and more β€” without needing root access or tedious ADB commands. -It’s designed for modern multiplatform development, accelerating debugging, QA, and iteration cycles. - -Screenshot 2025-09-12 at 15 39 45 - ---- - -## πŸš€ What Can Flocon Do? - -Once your device (Android / iOS / Desktop) is connected and your app includes the Flocon SDK, you can use the desktop companion app to access the following features: - -## ✨ Upcoming features - -Flocon is still evolving, next features : - -- Preview & Download files \ No newline at end of file +It’s designed for modern multiplatform development, accelerating debugging, QA, and iteration cycles. \ No newline at end of file diff --git a/docs/setup.md b/docs/setup.md index b7bbd85b..fca9eb4c 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,18 +1,5 @@ πŸ› οΈ Getting Started -## 🧰 Requirements - -### for android -- An Android device with USB debugging enabled -- Android Studio or SDK tools installed -- ADB (Android Debug Bridge) accessible from your system path - -### for all platforms -- Flocon Desktop app (JVM-based) -- Flocon SDK integrated into your app -- At least `kotlin 2.0.0` in your app -- Be aligned between the mobile library version & the desktop app version - ## Installation in your module .kts @@ -40,9 +27,20 @@ flocon = "LASTEST_VERSION" flocon = { module = "io.github.openflocon:flocon", version.ref = "flocon" } ``` -Download & install the last `Desktop client` - -https://github.com/openflocon/Flocon/releases +Download & install the last [Desktop client](https://github.com/openflocon/Flocon/releases) > [!NOTE] -> If you are on MacOS, you might need to follow specific instructions to open the app. See [MacOS Installation](macos-install.md). \ No newline at end of file +> If you are on MacOS, you might need to follow specific instructions to open the app. See [MacOS Installation](macos-install.md). + +## 🧰 Requirements + +### for android +- An Android device with USB debugging enabled +- Android Studio or SDK tools installed +- ADB (Android Debug Bridge) accessible from your system path + +### for all platforms +- Flocon Desktop app (JVM-based) +- Flocon SDK integrated into your app +- At least `kotlin 2.0.0` in your app +- Be aligned between the mobile library version & the desktop app version \ No newline at end of file