spotify-activity-listener/README.md

Poll Last.fm for your most recent Spotify listens.

# **Spotify Activity Listener**
### Poll Last.fm for your recent Spotify listening data.

## **Demo**
![The gif failed to load, please refresh your browser!](https://github.com/bradysheridan/spotify-activity-listener/blob/master/images/demo.gif)

## **Prerequisite Configuration**
1. [Create a Last.fm account](https://www.last.fm/join)
2. [Enable API access for your account](http://www.last.fm/api/account/create)
3. Make note of your API key
![The image failed to load, please refresh your browser!](https://github.com/bradysheridan/spotify-activity-listener/blob/master/images/api-key.png)
4. In Spotify, go to `Settings > Last.fm` and select `Connect to Last.fm`
![The image failed to load, please refresh your browser!](https://github.com/bradysheridan/spotify-activity-listener/blob/master/images/spotify-settings.jpg)

## **Installation**
1. `npm i spotify-activity-listener --save`

## **Usage**
### [**Full Usage Example (React.js)**](https://github.com/bradysheridan/spotify-activity-listener/blob/master/example/Example.js)
- Import the listener:
```javascript
import SpotifyListener from 'spotify-activity-listener';
// Or
var SpotifyListener = require('spotify-activity-listener');
```
- Instantiate the listener:
```javascript
var Listener = new SpotifyListener({
  username: 'YOUR_LAST.FM_USERNAME',
  key: 'YOUR_LAST.FM_API_KEY',
  pollInterval: 5000, // (Milliseconds)
  trackCount: 1, // Capped at 50 by Last.fm
  callback: (res) => {
    // Handle response data here
  }
});
```
- Start listening
```javascript
Listener.startListening();
```
- Stop listening (if need be)
```javascript
Listener.stopListening();
```

## **Response Format**
```javascript
[
  {
    album: "Atrocity Exhibition",
    art: "https://lastfm-img2.akamaized.net/i/u/300x300/514bed1643432ccf69854d30e35d24ba.png",
    artist: "Danny Brown",
    name: "Downward Spiral"
  },
  { /* (...) */ },
  { /* (...) */ }
]
```

## **Contribute**
1. Fork it
2. Create your branch
3. Make some changes
4. Commit the changes
5. Submit a pull request