Skip to content

Commit

Permalink
📝 Updated the README.md with docs
Browse files Browse the repository at this point in the history
Signed-off-by: Ayaka Neko <[email protected]>
  • Loading branch information
nekomeowww committed Sep 8, 2020
1 parent 0a10dea commit 69bc515
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,60 @@
<h1 align="center">MusicGenres</h1>
<p align="center">The JSON list for all the general music genres</p>
<p align="center">
<img src="https://github.com/nekomeowww/MusicGenres/workflows/Node%20Test/badge.svg" />
<img src="https://github.com/nekomeowww/MusicGenres/workflows/Node%20Build/badge.svg" />
</p>

## 安装 Installation

### CDN

```HTML
<script src="ttps://unpkg.com/musicgenres-json@latest/dist/index.js"></script>
```

### NPM
```bash
npm install musicgenres-json --save

# Or use Yarn

yarn add musicgenres-json
```

## 引入和使用 Import and Usage

### Browser

```HTML
<script>
const genres = new MusicGenres()
console.log(genres.get())
</script>
```

### ES6

```Javascript
import MusicGenres from 'musicgenres-json'
const genres = new MusicGenres()

console.log(genres.get())
```

## API Reference

### MusicGenres
**Type**: Class
**Properties**:
- genres
**Method**:
- get()

### genres
**Type**: Array
**Description**: the value of genres

### get()
**Type**: Function
**Description**: return genres as method

0 comments on commit 69bc515

Please sign in to comment.