Winds 🍃¶

Overview¶

Winds aims to provide a simple and efficient way to build and publish libraries and applications for multiple platforms. It is designed to be flexible and extensible, so that it can be used to build a wide variety of libraries and applications, from simple utility libraries to complex composable libraries and applications.

Features¶

• Simple and efficient build process
• Flexible and extensible library structure
• Support for multiple publication formats (Maven, AAR, etc.)
• Automatic documentation generation

Requirements¶

• Android Gradle Plugin 7.0+
• Kotlin Gradle Plugin 1.7+

How to Apply¶

Plugin implementation

To implement the Winds plugin, add the following plugin ID to your build.gradle file:

plugins {
  id("dev.teogor.winds") version "1.0.0-alpha04"
}

plugins {
  id 'dev.teogor.winds' version '1.0.0-alpha04'
}

To learn more about detailed implementation, please refer to the comprehensive documentation.

Usage¶

winds {
  buildFeatures {
    mavenPublish = true
    docsGenerator = true
  }

  mavenPublish {
    groupId = "my.group.id"
    artifactId = "my-library"
    version = "1.0.0"
  }
}

Getting Started

To get started with Winds, refer to the comprehensive documentation available at source.teogor.dev/winds. The documentation provides detailed explanations, examples, and best practices for using the library effectively.

Find this repository useful? 🩷¶

• Support it by joining stargazers for this repository. 📁
• Get notified about my new projects by following me on GitHub. 💻
• Interested in sponsoring me? Support me on GitHub! 🤝

License¶

Designed and developed by 2023 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.