Skip to content

Commit b6d97dd

Browse files
author
Martin Kirchgessner
committed
update README before releasing
1 parent 0d059f7 commit b6d97dd

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# drop2beets
22

3-
A [Beets](http://beets.io/) plug-in that imports singles as soon as they are dropped in a folder.
3+
A [Beets](http://beets.io/) plug-in that imports files as soon as they are dropped in a folder.
44

55
You can provide a function to set meta-data
66
or custom attributes depending on the sub-folder in which the file has been dropped.
@@ -21,12 +21,14 @@ pip install drop2beets
2121
```
2222

2323
Enable and configure the plug-in by running `beet config -e` and set at least
24-
one of default or singleton path to the "dropbox" folder.
24+
one of `default` or `singleton` in `dropbox_paths`.
25+
`debounce_window` defaults to 10, but we advise you set to at least 60 if you'd like to
26+
import albums.
2527

2628
```yaml
2729
plugins: drop2beets
2830
drop2beets:
29-
debounce_window: 10 # Seconds to wait for events to stop before importing. Should be set to at least 60 when importing albums. Default: 10
31+
debounce_window: 10 # Seconds to wait for file events to stop before importing.
3032
dropbox_paths:
3133
default: ~/beets-dropbox/albums
3234
singleton: ~/beets-dropbox/singles
@@ -70,7 +72,7 @@ drop2beets:
7072

7173
Now you're ready to test by calling `beet dropbox` on the command line and
7274
dropping a few files in the folder.
73-
Note that drop2beets starts 10 seconds after the last event it received about a file,
75+
Note that drop2beets starts a few seconds after the last event it received about a file,
7476
to ensure that the file has been copied or moved completely.
7577
Hit Ctrl+C to close the script.
7678

0 commit comments

Comments
 (0)