Skip to content

Commit 50d4ab1

Browse files
authored
Merge branch 'master' into dev
2 parents f58da9b + d9a663b commit 50d4ab1

File tree

5 files changed

+78
-5
lines changed

5 files changed

+78
-5
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,27 @@
1-
# Kotlin Spotify Web API
1+
# Kotlin Spotify Web API
2+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.adamratzman/spotify-api-kotlin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.adamratzman/spotify-api-kotlin)
3+
[![](https://img.shields.io/badge/Wiki-Docs-red.svg)](https://adamint.github.io/spotify-web-api-kotlin/-spotify-kotlin-wrapper/)
4+
[![CircleCI](https://circleci.com/gh/adamint/spotify-web-api-kotlin.svg?style=shield)](https://circleci.com/gh/adamint/spotify-web-api-kotlin)
5+
![](https://img.shields.io/badge/License-MIT-blue.svg)
6+
27
This is the [Kotlin](https://kotlinlang.org/) implementation of the [Spotify Web API](https://developer.spotify.com/web-api/)
38

9+
### Have a question?
10+
If you have a question, you can:
11+
12+
1. Create an [issue](https://github.com/adamint/spotify-web-api-kotlin/issues)
13+
2. Read (but that's hard)
14+
3. Contact me using **Adam#9261** on [Discord](https://discordapp.com) or by sending me an email
15+
416
## Contents
517
1. **[Downloading](#downloading)**
18+
2. **[Documentation](#documentation)**
619
2. **[Creating a SpotifyAPI or SpotifyClientAPI object](#creating-a-spotifyapi-or-spotifyclientapi-object)**
720
3. **[What is the SpotifyRestAction class?](#what-is-the-spotifyrestaction-class?)**
821
4. **[Using the Library](#using-the-library)**
922

1023
## Downloading
11-
This library is available via Maven Central.
24+
This library is available via Maven Central [here](https://search.maven.org/artifact/com.adamratzman/spotify-api-kotlin).
1225

1326
### Maven:
1427
```
@@ -39,7 +52,9 @@ dependencies {
3952

4053
#### Android
4154
This library should work out of the box on Android.
42-
```
55+
56+
## Documentation
57+
The `spotify-web-api-kotlin` KDocs are hosted at https://docs.adamratzman.com/-spotify-kotlin-wrapper/
4358

4459
## Creating a SpotifyAPI or SpotifyClientAPI object
4560
In order to use the methods in this library, you must create either a `SpotifyAPI` or `SpotifyClientAPI` object using their respective exposed builders. Client-specific methods are unable to be accessed with the generic SpotifyAPI, rather you must create an instance of the Client API.

build.gradle

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,10 @@ dependencies {
4949
exclude group: 'org.junit.platform'
5050
exclude group: 'org.jetbrains.kotlin'
5151
}
52-
52+
5353
testImplementation('org.junit.jupiter:junit-jupiter-api:5.4.0')
5454
testImplementation(group: 'org.json', name: 'json', version: '20180130')
5555
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.4.0'
56-
5756
}
5857

5958
dokka {

docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.adamratzman.com

0 commit comments

Comments
 (0)