Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 3.35 KB

README.md

File metadata and controls

70 lines (52 loc) · 3.35 KB
Raw

🔍 CrossLens 🔍

Overview

License Maven Central Profile Open-Source Directory

🔍 CrossLens delivers precise platform insights for Kotlin Multiplatform projects, enabling seamless adaptation across diverse environments.

Features

  • Multi-Platform Support: Access detailed information about the platform your code runs on, across various environments.
  • Seamless Integration: Integrate smoothly with your existing Kotlin Multiplatform projects.
  • Up-to-Date Insights: Keep informed with the latest platform information for compatibility and optimal performance.

Getting Started

  1. Add CrossLens to your Kotlin Multiplatform project.
  2. Utilize the provided APIs to fetch platform-specific details.
  3. Adapt your code based on the insights provided by CrossLens.

Installation

Add the following to your build.gradle.kts:

dependencies {
  implementation("dev.teogor.crosslens:crosslens-compose:1.0.0-alpha02")
  implementation("dev.teogor.crosslens:crosslens-core:1.0.0-alpha02")
  implementation("dev.teogor.crosslens:crosslens-ui:1.0.0-alpha02")
}

Kotlin Multiplatform Support

CrossLens supports the following platforms:

  • JVM: Full support for JVM with Kotlin toolchain version 11.
  • JavaScript (JS): Compatible with both browser and Node.js environments using Kotlin/JS IR backend.
  • WASM: WebAssembly support for browser and Node.js environments.
  • iOS: Native support for iOS devices, including x64, Arm64, and Simulator Arm64.
  • macOS: Native support for macOS devices, including x64 and Arm64.
  • Linux: Native support for Linux devices, including x64 and Arm64.
  • tvOS: Native support for tvOS devices, including x64, Arm64, and Simulator Arm64.
  • watchOS: Native support for watchOS devices, including x64, Arm32, Arm64, Device Arm64, and Simulator Arm64.

Contributing

Contributions are welcome! If you have ideas, bug reports, or feature requests, please open an issue or submit a pull request. For more details, refer to our Contributing Guidelines.

Find this repository useful? ❤️

Support it by joining the stargazers for this repository. ⭐
Also, follow me on GitHub for updates on my next creations! 🤩

License

  Designed and developed by 2024 teogor (Teodor Grigor)

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.