Skip to content

Commit f81a99d

Browse files
committed
fix: add PyPI logo to badge, clean up README and gitignore
- Add logo=pypi to PyPI badge, remove downloads badge - Slim down Quick Start to just config setup (no command duplication) - Gitignore node_modules, package.json, package-lock.json
1 parent b117a57 commit f81a99d

2 files changed

Lines changed: 8 additions & 13 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,6 @@ dist/
1010
build/
1111
clickwheel.db
1212
.ruff_cache/
13+
node_modules/
14+
package.json
15+
package-lock.json

README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# clickwheel
22

3-
[![PyPI](https://img.shields.io/pypi/v/clickwheel)](https://pypi.org/project/clickwheel/)
4-
[![Downloads](https://img.shields.io/pypi/dm/clickwheel)](https://pypi.org/project/clickwheel/)
3+
[![PyPI](https://img.shields.io/pypi/v/clickwheel?logo=pypi&logoColor=white)](https://pypi.org/project/clickwheel/)
54
[![CI](https://github.com/pdugan20/clickwheel/actions/workflows/ci.yml/badge.svg)](https://github.com/pdugan20/clickwheel/actions/workflows/ci.yml)
65
[![Python](https://img.shields.io/badge/Python-%3E%3D3.11-3776AB?logo=python&logoColor=white)](https://www.python.org/)
76
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/MIT)
@@ -24,24 +23,17 @@ pipx install 'clickwheel[artwork]'
2423

2524
## Quick Start
2625

26+
Create a config file pointing to your music library:
27+
2728
```bash
28-
# Point clickwheel at your music library
2929
mkdir -p ~/.clickwheel
3030
cat > ~/.clickwheel/config.yaml << 'EOF'
3131
music_dir: /path/to/your/music
3232
EOF
33-
34-
# Scan and clean up metadata
35-
clickwheel scan
36-
clickwheel fix
37-
38-
# Pick music for the iPod and sync
39-
clickwheel select
40-
clickwheel diff
41-
clickwheel sync
42-
clickwheel eject
4333
```
4434

35+
Then run `clickwheel scan` to index your library and `clickwheel select` to start picking music for your iPod.
36+
4537
## Commands
4638

4739
| Command | Description |

0 commit comments

Comments
 (0)