@aaronlcj/use-last-fm/README.md

Get data from last.fm as a React hook.

![use-last-fm](docs/use-last-fm.jpg)

![CI Status](https://github.com/webmail/use-last-fm/workflows/CI/badge.svg)

Stream your currently playing song through last.fm as a React hook.
Forked from Alistair Smith - aliii
# Features

- 📦 **Tiny**: `use-last-fm` weighs in at **less than** 700 bytes minified and gzipped.
- 🌳 **Universal**: we dist esm and cjs modules.
- 👨‍💻 **Developer friendly**: Helpful development messages that are stripped away in production
- ⌨️ **Strongly typed**: `use-last-fm` is written in TypeScript and encourages good practices this way

## Installation

##### With NPM

> `npm i --save @aaronlcj/use-last-fm`

##### Or, with yarn:

> `yarn add @aaronlcj/use-last-fm`

## Usage

```tsx
import { useLastFM } from 'use-last-fm';

const CurrentlyPlaying = () => {
  const lastFM = useLastFM({method: {type: 'user', node: 'recentlyPlayed'}, param: 'aabbccsmith'}, '[add api token here]');

  if (lastFM.status !== 'playing') {
    return <p>Not listening to anything</p>;
  }

  return (
    <p>
      Listening to {lastFM.song.name} by {lastFM.song.artist}
    </p>
  );
};
```

A full example can be seen in the [examples](https://github.com/aaronlcj/use-last-fm/tree/master/example) folder