Skip to content

A Siren parsing library written in Kotlin

License

Notifications You must be signed in to change notification settings

DataGraham/ksiren

 
 

Repository files navigation

KSiren

Kotlin Build status Coverage Status Download

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.
  • 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.

Versioning

Ksiren is maintained under the Semantic Versioning guidelines.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

About

A Siren parsing library written in Kotlin

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Kotlin 100.0%