-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
• Updated Hero image • Added screenshots • Added Features, How to Use, Note, Disclaimer sections
- Loading branch information
1 parent
2426f9b
commit 701eaba
Showing
1 changed file
with
32 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,35 @@ | ||
<p align="center"><img width=100% src="https://www.dropbox.com/s/i5wr4v6ehrxfpqg/Carol%20Github%20Icon.png?raw=1"></p> | ||
<br> | ||
<h1 align="center">Carol</h1> | ||
<p align="center"><img width=100% src="https://www.dropbox.com/s/ui6ihgtrnrx7hdc/GitHub%20Hero.jpg?raw=1"></p> | ||
<h2 align="center">Carol</h2> | ||
<p align="center">Carol is a minimal and beautiful lyrics app for macOS</p> | ||
<br> | ||
<p align="center"><img width=100% src="https://www.dropbox.com/s/kaa8wtuiop2oig5/Screenshots.png?raw=1"></p> | ||
<br> | ||
|
||
## Features | ||
* Supports Apple Music and Spotify | ||
* Minimal design with support for Album artworks | ||
* Fetches lyrics from ![Musixmatch](https://www.musixmatch.com) - world's largest catalog of lyrics | ||
* Stays in the menu bar of macOS for quick access | ||
* Light in size | ||
<br> | ||
|
||
### Limitations | ||
1. The uses the free version of Musixmatch api which returns only 30% of lyrics. | ||
## How to use | ||
#### Requirements | ||
macOS 10.10 (OS X Yosemite) and above | ||
#### Download | ||
Download the latest release from here. | ||
#### Install | ||
1. Double click the `Carol-<version>.pkg` file. | ||
2. Follow the onscreen instructions to install the app. | ||
|
||
Note - If you security settings do not allow to install apps from third party developers, go to `Preferences -> Security & Privacy -> General Tab`. You will be shown an `Open Anyway` button if you had tried to install the app before. Use this and you will be good to go. | ||
#### Launch | ||
Launch the app from Applications folder. It will open in your menu bar. Enjoy. | ||
<br> | ||
|
||
## Note | ||
1. The app uses the free version of Musixmatch api which returns only 30% of a song's lyrics. | ||
2. Background artwork only works with songs that are in your iTunes library. | ||
|
||
## Disclaimer | ||
This project is for learning purpose only. If you want to learn macOS development and Xamarin technologies, feel free to use this project. Please do not sell/re-sell the project or its content as it uses the free plan of Musixmatch API which prohibits it for any commercial use. Use it at your own risk. |