diff --git a/README.md b/README.md index f20b634..a87bc71 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,35 @@ -

-
-

Carol

+

+

Carol

Carol is a minimal and beautiful lyrics app for macOS

+
+

+
+ +## 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 +
-### 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-.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. +
+ +## 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.