Added README

This commit is contained in:
Geomitron
2021-03-19 16:52:32 -05:00
parent 53923ebe28
commit 393aa8d8fa
2 changed files with 41 additions and 0 deletions

41
README.md Normal file
View File

@@ -0,0 +1,41 @@
<p align="center">
<img src="./src/assets/images/bridge-animation.gif"/>
</p>
<h3 align="center">A Clone Hero library management tool with built in chart searching and downloading.</h3>
<img align="center" style="border: 2px solid #E0E0E0" src="./src/assets/images/example.png"/>
<p align="center">
<a href="https://discord.gg/cqaUXGm">Discord</a> |
<a href="https://trello.com/b/lz8MvNhF/bridge">Trello</a>
</p>
<hr>
**Bridge** is a desktop application that helps CloneHero players browse, find, download, and extract new charts very quickly and eaisly.
## Features
- ✅ Find all charts that can be found on Chorus.
- ✅ Download and extract any chart directly into your chart library.
- ✅ Multi-select songs to add to the download queue.
- ✅ Cancel and retry downloads.
- ✅ Google Authentication to avoid rate limited downloads.
- ✅ In-app update checking and downloading.
- ⚠️ Theme support.
- ❌ Advanced song search.
- ❌ Scan and fix certain metadata problems in your chart library.
- ❌ Easily download the most up-to-date versions of charts in your library.
Key:
- ✅ Complete
- ⚠️ In progress
- ❌ Not yet started
### Development
Built using Node.js, Angular, and Electron.
After installing Node.js and cloning the repository, install dependencies and run development with:
```
$ npm install && npm start
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 381 KiB