drone-plugin-lib/README.md

36 lines
1.7 KiB
Markdown

# drone-plugin-lib
[![Build Status](https://img.shields.io/drone/build/thegeeklab/drone-plugin-lib?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/drone-plugin-lib)
[![Go Report Card](https://goreportcard.com/badge/github.com/thegeeklab/drone-plugin-lib)](https://goreportcard.com/report/github.com/thegeeklab/drone-plugin-lib)
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/drone-plugin-lib)](https://github.com/thegeeklab/drone-plugin-lib/graphs/contributors)
[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/drone-plugin-lib)
[![License: Apache-2.0](https://img.shields.io/github/license/thegeeklab/drone-plugin-lib)](https://github.com/thegeeklab/drone-plugin-lib/blob/main/LICENSE)
Helper library to reduce the boilerplate code for writing Drone CI plugins.
## Usage
### Download the package
```Shell
go get -d github.com/thegeeklab/drone-plugin-lib/v2/errors
go get -d github.com/thegeeklab/drone-plugin-lib/v2/urfave
go get -d github.com/thegeeklab/drone-plugin-lib/v2/drone
```
### Import the package
```Go
import "github.com/thegeeklab/drone-plugin-lib/v2/errors"
import "github.com/thegeeklab/drone-plugin-lib/v2/urfave"
import "github.com/thegeeklab/drone-plugin-lib/v2/drone"
```
## Contributors
Special thanks to all [contributors](https://github.com/thegeeklab/drone-plugin-lib/graphs/contributors). If you would like to contribute, please see the [instructions](https://github.com/thegeeklab/drone-plugin-lib/blob/main/CONTRIBUTING.md).
## License
This project is licensed under the Apache-2.0 License - see the [LICENSE](https://github.com/thegeeklab/drone-plugin-lib/blob/main/LICENSE) file for details.