Skip to content

Commit

Permalink
Update Readme [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Soapwood committed Jul 22, 2024
1 parent 4b85dd0 commit f1f6b12
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 4 deletions.
Binary file added .github/readme/NotificationsMenu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/readme/OverlayDemo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/readme/RecognitionMenu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/readme/VXMusicDesktopHome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,48 @@

<div align="center">

## Music Recognition Overlay for Social VR
### Also suitable for Desktop use!

# Get VXMusic
[![Discord](https://img.icons8.com/?size=100&id=103169&format=png&color=000000)](https://github.com/Soapwood/VXMusic/latest)

Download Installer

<div align="left">

## Installation
# Installation
An Installer is available from the Releases page.
Using the Installer will allow you to stay updated with latest versions of VXMusic.

A loose build is also available for evaluation. This is designed to be used by the Auto Updater to get new versions and is not recommended for long term use.

## Updates
# Updates

# Usage

## VXMusic Overlay
### 🎵 Recognise tracks at live events

<img src=".github/readme/OverlayDemo.gif" alt="VXMusic Desktop" style="max-width: 80%">


## VXMusic Desktop
<img src=".github/readme/VXMusicDesktopHome.png" alt="VXMusic Desktop" style="max-width: 100%">

### Recognition


### Notifications


### Connections
#### ⚠️ Note: Spotify Integration
The Spotify Integration App is currently undergoing review by Spotify.

## How to Use
Until this is complete, it is currently required to manually add Users to the App configuration for the Playlists feature to work.

##
Please reach out on [Discord](https://t.co/Z2eSKfYpfs) to have your Spotify account added!


## License
Expand Down

0 comments on commit f1f6b12

Please sign in to comment.