From 6bf8699f58a5e7a255a18e57613d3250b7796a24 Mon Sep 17 00:00:00 2001 From: Allan Gomes Date: Sun, 18 Aug 2024 20:25:02 -0300 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index b235104..231734b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ [![Maven Central Version](https://img.shields.io/maven-central/v/io.github.allangomessl/kotlinwind-css)](https://search.maven.org/artifact/io.github.allangomessl/kotlinwind-css) [![Tests](https://github.com/allangomessl/kotlinwind-css/actions/workflows/on-push.yml/badge.svg?branch=dev&event=push)](https://github.com/allangomessl/kotlinwind-css/actions/workflows/on-push.yml) +

+ ## Overview Kotlinwind CSS is a Kotlin library that enhances your experience with [kotlinx.html](https://github.com/Kotlin/kotlinx.html) by providing a more Kotlin-centric approach to styling HTML. Inspired by Tailwind CSS, this library allows you to apply CSS styles directly within your HTML-building code, utilizing Kotlin's type-safe, declarative syntax through a Kotlin DSL (Domain-Specific Language). @@ -14,6 +16,8 @@ Kotlinwind CSS is a Kotlin library that enhances your experience with [kotlinx.h Demonstration

+

+ ## Features - **Type-Safe CSS**: Write CSS directly in Kotlin using a type-safe API. @@ -21,16 +25,22 @@ Kotlinwind CSS is a Kotlin library that enhances your experience with [kotlinx.h - **Declarative Syntax**: Benefit from Kotlin's expressive DSL to manage styles inline, reducing the need for external stylesheets. - **Inspired by Tailwind CSS**: Leverage a similar utility-first approach for styling, now available in Kotlin. +

+ ## Code Preview | Kotlinwind CSS Code | Resulting HTML | | -------- | ------- | | Screenshot 2024-08-17 at 13 00 49 | Screenshot 2024-08-17 at 10 56 55 | +

+ ## Motivation Kotlinwind CSS is built for developers who prefer a Kotlin-native way of styling HTML. By leveraging Kotlin's type-safe, declarative DSL and drawing inspiration from the utility-first approach of Tailwind CSS, this library eliminates the need for traditional CSS files and provides a more cohesive development experience within Kotlin projects. +

+ ## Getting Started To start using Kotlinwind CSS in your project, add the following dependency to your `build.gradle.kts` file: @@ -41,14 +51,20 @@ implementation("io.github.allangomessl:kotlinwind-css:{VERSION}") Replace `{VERSION}` with the latest version available on [Maven Central](https://search.maven.org/artifact/io.github.allangomessl/kotlinwind-css). +

+ ## Documentation For detailed usage instructions and examples, visit the [Wiki](https://github.com/allangomessl/kotlinwind-css/wiki). +

+ ## Limitations Currently, Kotlinwind CSS supports only inline styles. Future versions will introduce support for external stylesheets and CSS classes. +

+ ## Roadmap - **0.0.2 - 0.0.9** @@ -66,6 +82,8 @@ Currently, Kotlinwind CSS supports only inline styles. Future versions will intr - Jetpack Compose Integration (returning a `Modifier`) - Interactivity Support (JS/TS Framework Integration) +

+ ### Note Interactivity is not a priority at this stage, as starting with a JS/TS framework may be more beneficial for projects requiring dynamic behavior.