README updates

This commit is contained in:
WNguyen14
2023-10-09 16:34:37 -04:00
parent bc2c940577
commit f818df6cc6

View File

@@ -3,14 +3,14 @@
</p> </p>
<h3 align="center">A Clone Hero library management tool with built in chart searching and downloading.</h3> <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"/> <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> <hr>
**Bridge** is a desktop application that helps CloneHero players browse, find, download, and extract new charts very quickly and eaisly. **Bridge** is a desktop application that helps CloneHero players browse, find, download, and extract new charts very quickly and eaisly.
## Setup
Head over to the [Releases](https://github.com/Geomitron/Bridge/releases/tag/v1.5.0) page to download the appropriate install wizard.
## Features ## Features
- ✅ Find all charts that can be found on Chorus. - ✅ Find all charts that can be found on Chorus.
@@ -30,12 +30,30 @@ Key:
- ⚠️ In progress - ⚠️ In progress
- ❌ Not yet started - ❌ Not yet started
### What's new in v1.5.0
v.1.5.0
- Update to Angular 14
- Update to Electron 23
- Table header is now sticky
- API Endpoints updated (older versions will no longer work)
- Removed Google Authentication (it stopped working and can't be fixed; an alternative solution is in the works)
### Development ### Development
Built using Node.js, Angular, and Electron. Built using Node.js, Angular, and Electron.
Learn how to install Node.js [here](https://nodejs.dev/en/download/)
After installing Node.js and cloning the repository, install dependencies and run development with: After installing Node.js and cloning the repository, install dependencies and run development with:
``` ```
$ npm install && npm start $ npm install && npm start
``` ```
### Socials
To inquire about the project and make suggestions, please join the [Discord](https://discord.gg/cqaUXGm)
To see which features in currently in the works, please take a look at the [Trello](https://trello.com/b/lz8MvNhF/bridge)