diff --git a/README.md b/README.md index 831ac00..6e44aed 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,21 @@ Buy Me a Coffee at ko-fi.com [vaporiser](https://github.com/rnnh/vaporiser) is a Python script that creates a vaporwave (slowed, with reverb) remix of a given MP3 file, with the option of playing over a looped GIF as a video. -It adds reverb, applies a low-pass filter, slows down, and pitches down an input MP3 file. -The result is written to a new MP3 file, and if a GIF is given in the command, an MP4 video file of the GIF on repeat for the duration of the remix is also created. -The speed, pitch and low-pass filter cutoff can be controlled with the `--speed`, `--pitch` and `--lowpass` arguments (these are optional, default parameters are provided). -See [usage](#usage) for a full list of available effects. +It applies audio effects to an input MP3 file, and writes the result to a new MP3 file. +If a GIF is given in the command, an MP4 video file of the GIF on repeat for the duration of the remix is also created. +Vaporiser can apply the following audio effects: + +- Speed shift +- Pitch shift +- Lowpass filter +- Bass boost +- Gain adjustment +- Out Of Phase Stereo (karaoke) effect +- Phaser effect +- Tremolo effect +- Compand + +See [usage](#usage) for details of available effects. # Contents