# ksiren

**Repository Path**: mirrors_Brightspace/ksiren

## Basic Information

- **Project Name**: ksiren
- **Description**: A Siren parsing library written in Kotlin
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# KSiren
[ ![Kotlin](https://img.shields.io/badge/Kotlin-1.3.31-blue.svg)](http://kotlinlang.org)
![Build status](https://github.com/Brightspace/ksiren/actions/workflows/ci.yml/badge.svg)

A Kotlin library for parsing responses from Siren API endpoints and building Siren Action requests.

## Quick start

Options for getting started:

* [Download the latest release](../../releases).
* Clone the repo: `git clone https://github.com/Brightspace/ksiren.git`.
* Include the library in your project with gradle:
```
compile 'com.brightspace.ksiren:ksiren:1.1.0'
```
You must import, or create yourself, a JSON parsing plugin; adapters for moshi and gson are available and can be pulled in using one of the following gradle compile commands:
```
compile 'com.brightspace.ksiren:ksiren-moshi-adapter:1.1.0'
compile 'com.brightspace.ksiren:ksiren-gson-adapter:1.1.0'
```

Optionally, you can include, or create, a request building plugin; an adapter for okhttp3 is available:
```
compile 'com.brightspace.ksiren:ksiren-okhttp3-request-builder:1.0.0'
```

## Documentation

See [the wiki](https://github.com/Brightspace/ksiren/wiki).

## Versioning

Ksiren is maintained under [the Semantic Versioning guidelines](http://semver.org/).

## Contributing

Please read through our [contributing guidelines](CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.