Skip to content
This repository has been archived by the owner on Nov 11, 2023. It is now read-only.

Commit

Permalink
2.0.0 Release
Browse files Browse the repository at this point in the history
  • Loading branch information
dylhack committed Jun 22, 2019
2 parents 30fd8bb + fc27c95 commit e07a9b4
Show file tree
Hide file tree
Showing 77 changed files with 22,846 additions and 703 deletions.
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/
17 changes: 17 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"env": {
"browser": true,
"commonjs": true,
"es6": true
},
"extends": "airbnb-base",
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
},
"parserOptions": {
"ecmaVersion": 2018
},
"rules": {
}
}
88 changes: 88 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache

# next.js build output
.next

# nuxt.js build output
.nuxt

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/
50 changes: 1 addition & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,55 +2,7 @@
[![Travis](https://travis-ci.com/dylhack/vlc.js.svg?branch=master)](https://travis-ci.com/dylhack/vlc.js)
[![npm version](https://badge.fury.io/js/vlc.js.svg)](https://badge.fury.io/js/vlc.js)
---
VLC HTTP endpoint wrapper for NodeJS. Three parts to this wrapper; commands, routes, and client. The wrapper is callback-oriented, but the Client returns promises for each method and will resolve with VLC's current status.

## Routes
- [status](./src/routes/status.js),
- This will retrieve the status of VLC
- Client.getStatus()
- [playlist](./src/routes/playlist.js),
- This will retreive the current playlist.
- Client.getPlaylist()

## Commands
- [add](./src/commands/add.js)
- Add a song based on MRL
- Client.add(mrl)
- [empty](./src/commands/empty.js)
- Empty playlist
- Client.empty()
- [fullscreen](./src/commands/fullscreen.js)
- Toggle fullscreen (pretty useless)
- Client.fullscreen()
- [loop](./src/commands/loop.js)
- Loop playlist
- Client.loop()
- [next](./src/commands/next.js)
- Plays next song
- Client.next()
- [pause](./src/commands/pause.js)
- Toggle pause
- Client.pause()
- [play](./src/commands/play.js)
- Play song based on ID.
- If an ID is not provided it'll unpause or restart current song.
- Client.play(id)
- [previous](./src/commands/previous.js)
- Play previous song
- Client.previous()
- [remove](./src/commands/remove.js)
- Remove song based on ID
- If no ID is provided it'll remove the current song
- Client.remove(id)
- [repeat](./src/commands/repeat.js)
- Repeat song
- Client.repeat()
- [shuffle](./src/commands/shuffle.js)
- Toggle shuffle
- Client.shuffle()
- [volume](./src/commands/volume.js)
- Set volume based on value
- Client.volume(value)
VLC HTTP endpoint wrapper for NodeJS developers. All documentation can be found in the [docs](./docs/) directory.

## Contact us
Join us on [Discord.](https://discord.gg/XkqW2Fd)
Loading

0 comments on commit e07a9b4

Please sign in to comment.