|
1 | 1 | <h1 align="center"> |
| 2 | + <br> |
| 3 | + <img src="https://raw.githubusercontent.com/quantumkv/nighthawk/master/build/icon.png" alt="Nighthawk" width="200"> |
2 | 4 | <br> |
3 | 5 | Nighthawk |
4 | 6 | <br> |
5 | 7 | </h1> |
6 | 8 |
|
7 | | -<h4 align="center">A stealthy, simple music player that stays out of your way in your Menubar/Taskbar </h4> |
| 9 | +<h4 align="center">A stealthy, simple, unobtrusive music player that stays out of your way in your Menubar/Taskbar </h4> |
| 10 | + |
| 11 | +<p align="center"> |
| 12 | + <a href="#key-features">Key Features</a> • |
| 13 | + <a href="#how-to-use">How to Use</a> • |
| 14 | + <a href="#download">Download</a> • |
| 15 | + <a href="#credits">Credits</a> • |
| 16 | + <a href="#license">License</a> |
| 17 | +</p> |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | +## Key Features |
| 22 | + |
| 23 | +* Works completely in the tray. Hides automatically when it looses focus. |
| 24 | +* Does not appear in the taskbar and window lists when hidden. |
| 25 | +* Supports keyboard media keys to control the player. |
| 26 | +* A powerful queue manager to manage your playing queue. |
| 27 | +* Highly Efficient. |
| 28 | +* More Features to come soon. |
| 29 | + |
| 30 | +## How To Use |
| 31 | + |
| 32 | +* Download the appropriate setup and install. |
| 33 | +* The app only lives in the tray. You have to manipulate it from there. - For Windows, the icon will in the tray next to the clock on the taskbar. Click to show the player. Right click will open up the tray menu with extra options. - For Ubuntu and MacOS, the icon will be in the top-right corner of the screen. |
| 34 | + |
| 35 | +#### For First Time Users: |
| 36 | + |
| 37 | +* Click the settings button on the top of the window and select the folder with your mp3 files. |
| 38 | +* Click of refresh button and wait for the tracks to be loaded. |
| 39 | + |
| 40 | +## Download |
| 41 | + |
| 42 | +You can download latest installers from your OS [from the releases page](https://github.com/quantumkv/nighthawk/releases) |
| 43 | + |
| 44 | +Current only the following OS are supported: |
| 45 | + |
| 46 | +* Windows 7 and greater (64 bit) |
| 47 | +* Ubuntu 12.04 and greater (64 bit) |
| 48 | +* MacOS X 10.9 and greater |
| 49 | + |
| 50 | +## Credits |
8 | 51 |
|
9 | | -The project is currently going a rewrite. The old working versions can be bound in the `old` branch and in the releases page. |
| 52 | +* [Electron](http://electronjs.org/) |
| 53 | +* [Immer](https://github.com/mweststrate/immer) |
| 54 | +* [Dexie](http://dexie.org/) |
| 55 | +* [Electron Builder](https://www.electron.build/) |
| 56 | +* [React Virtualized](https://bvaughn.github.io/react-virtualized/) |
| 57 | +* [music-metadata](https://github.com/borewit/music-metadata) |
10 | 58 |
|
11 | 59 | ## License |
12 | 60 |
|
|
0 commit comments