From fab0705c26072cc72259a8b955fab37f76cfa07b Mon Sep 17 00:00:00 2001 From: Steve Soltys Date: Sun, 30 Aug 2020 17:00:39 -0400 Subject: [PATCH] Add license, readme, and Travis file --- .travis.yml | 4 ++++ LICENSE | 21 +++++++++++++++++++++ README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 65 insertions(+) create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 README.md diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..4a39d02 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,4 @@ +language: java + +jdk: +- openjdk11 \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0e9d028 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2020 Steve Soltys + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3e40ee4 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Apple Music +[![Build Status](https://travis-ci.com/stevesoltys/applemusic.svg?branch=master)](https://travis-ci.org/stevesoltys/applemusic) + +An [Apple Music API](https://developer.apple.com/documentation/applemusicapi/) wrapper. + +## Installation +```groovy +repositories { + jcenter() + maven { url 'https://jitpack.io' } +} + +dependencies { + compile 'com.github.stevesoltys:applemusic:0.1.0' +} +``` + +## Usage +Create an `AppleMusic` instance with your credentials, and run an API query. + +Here's an example: +```kotlin +val appleMusic = AppleMusic( + teamId = "A93J3NMCK2", + privateKey = Files.readAllBytes(Path.of("private.key")), + keyId = "S019516J93", + storefront = "us" +) + +val searchResultArtist = appleMusic.search( + "j cole", types = setOf(SearchResultType.ARTISTS) +).results?.artists?.data?.first() + +val artistAlbums = appleMusic.getAllAlbumsByArtistId(searchResultArtist!!.id!!) + +// ... +``` + +## License +This library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).