https://github.com/teogor/winds
🍃 Winds build and publish libraries and applications for multiple platforms, simple and efficient.
https://github.com/teogor/winds
docs documentation gradle-plugin kotlin kotlin-dsl maven plugin publish publishing
Last synced: 5 months ago
JSON representation
🍃 Winds build and publish libraries and applications for multiple platforms, simple and efficient.
- Host: GitHub
- URL: https://github.com/teogor/winds
- Owner: teogor
- License: apache-2.0
- Created: 2023-11-03T10:23:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-10-24T10:58:53.000Z (8 months ago)
- Last Synced: 2025-10-24T12:30:14.781Z (8 months ago)
- Topics: docs, documentation, gradle-plugin, kotlin, kotlin-dsl, maven, plugin, publish, publishing
- Language: Kotlin
- Homepage: https://source.teogor.dev/winds
- Size: 621 KB
- Stars: 22
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
## Winds 🍃
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+
### Usage
**Plugin implementation**
To implement the Winds plugin, add the following plugin ID to your build.gradle file:
```kotlin
plugins {
id("dev.teogor.winds") version "1.0.3"
}
```
**Plugin usage**
Once you have implemented the Winds plugin, you can use it to build and publish your library or
application as follows:
1. Configure the Winds plugin in your build.gradle file.
2. Build your library or application using the `gradlew build` command.
3. Publish your library or application using the `gradlew publish` command.
**Example build.gradle file**
The following is an example build.gradle file that uses the Winds plugin to build and publish a
library:
```kotlin
plugins {
id("dev.teogor.winds") version "1.0.3"
}
winds {
buildFeatures {
mavenPublish = true
docsGenerator = true
}
mavenPublish {
groupId = "my.group.id"
artifactId = "my-library"
version = "1.0.0"
}
}
```
## Find this repository useful? 🩷
* Support it by joining __[stargazers](https://github.com/teogor/winds/stargazers)__ for this
repository. 📁
* Get notified about my new projects by __[following me](https://github.com/teogor)__ on GitHub. 💻
* Interested in sponsoring me? [Support me](sponsor.md) on GitHub! 🤝
# License
```xml
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.
```