diff --git a/README.md b/README.md new file mode 100644 index 0000000..cdd3021 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +

+ +

+

A Clone Hero library management tool with built in chart searching and downloading.

+ +

+ Discord | + Trello +

+
+ +**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 +``` \ No newline at end of file diff --git a/src/assets/images/example.png b/src/assets/images/example.png new file mode 100644 index 0000000..6f9ee85 Binary files /dev/null and b/src/assets/images/example.png differ