Skip to content

Commit

Permalink
Move keyboard shortcuts in README
Browse files Browse the repository at this point in the history
  • Loading branch information
xarantolus committed Jul 16, 2023
1 parent 847073d commit 14e0848
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,16 @@ and syncing using external programs.


### Features
* Easily edit [ID3v2 tags](https://en.wikipedia.org/wiki/ID3) like title, artist, album, year and the cover image
* [Import](#Importing) songs you already have
* Set up FTP clients to [sync](#Syncing) your music to all your devices
* Download manager: simply add songs using [youtube-dl](https://github.com/ytdl-org/youtube-dl)
* Automagic metadata extraction (including cover images)
* List and search your songs by title, artist, album or year
* Very likely works on your server, [even a Raspberry Pi](#Resources) works fine
* Automatic dark mode: the site applies a light or dark theme depending on your system settings
* Keyboard shortcuts for faster navigation
- `n` for loading the page where you can add new songs
- Listings: `s` for all songs, `a` for artists, `y` for years, `i` for incomplete, `e` for recent edits and `u` for unsynced songs
- `/` for focusing on the search bar
- `esc` for going to the main page
* Easily edit [ID3v2 tags](https://en.wikipedia.org/wiki/ID3) like title, artist, album, year and the cover image
* [Import](#Importing) songs you already have
* Set up FTP clients to [sync](#Syncing) your music to all your devices
* Download manager: simply add songs using [youtube-dl](https://github.com/ytdl-org/youtube-dl)
* Automagic metadata extraction (including cover images)
* List and search your songs by title, artist, album or year
* Very likely works on your server, [even a Raspberry Pi](#Resources) works fine
* Automatic dark mode: the site applies a light or dark theme depending on your system settings
* Keyboard shortcuts for faster navigation
* No JavaScript required


### Screenshots
Expand Down Expand Up @@ -309,6 +306,14 @@ There are several assumptions made so the program will work as expected in most
- All cover images are squared. Any that aren't will be cropped and some part of the image will be removed.


### Keyboard shortcuts
These are keyboard shortcuts that can be used on any page:
- `n` for loading the page where you can add new songs
- Listings: `s` for all songs, `a` for artists, `y` for years, `i` for incomplete, `e` for recent edits and `u` for unsynced songs
- `/` for focusing on the search bar
- `esc` for going to the main page


### Browser support
The website should work in most modern browsers. It uses [native image lazy loading](https://caniuse.com/#feat=loading-lazy-attr) which is not yet supported by all browsers, but images will load without it regardless. If you use a recent browser version, it will be just a bit snappier.

Expand Down

0 comments on commit 14e0848

Please # to comment.