diff --git a/README.md b/README.md
index 7947c46..c5f5808 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,21 @@
# Discord Voice Recorder
-A [Discord.js](https://discord.js.org/#/) script which can record voice calls. Summon the bot to a voice channel, and voilĂ ! the audio is piped right into your local machine.
+A [Discord.js](https://discord.js.org/#/) script which can record voice calls. Summon the bot to a voice channel, and voilĂ ! the audio is piped right into your local machine. Jump to [Installation & Usage](https://github.com/chebro/discord-voice-recorder#installation-and-usage) to get started.
-Jump to [Installation & Usage](https://github.com/chebro/discord-voice-recorder#installation-and-usage) to get started.
-
-_Recording voice calls without prior consent violates privacy. Do not use this bot without approval. I'm not responsible for your insanity._
-
-
+
+### Index
- [Installation and Usage](#installation-and-usage)
- - [Run Locally](#run-locally)
- - [Run as Docker Container](#run-as-docker-container)
+
+ - [Run Locally](#run-locally)
+ - [Run in Container](#run-in-container)
- [Bot Commands](#bot-commands)
+
- [Managing the Output](#managing-the-output)
- [Merge Recording](#merge-recording)
- [Convert the Merged File to MP3](#convert-the-merged-file-to-mp3)
-- [Thanks](#thanks)
+
+_**Note:** Recording voice calls without prior consent violates privacy. Do not use this bot without approval. I'm not responsible for your insanity._
## Installation and Usage
@@ -24,7 +24,7 @@ Clone the repository :
git clone https://github.com/chebro/discord-voice-recorder/
```
-[Make a discord bot](https://discordpy.readthedocs.io/en/latest/discord.html) if you don't have one already and invite the bot to your server, then:
+[Create a discord bot](https://discordpy.readthedocs.io/en/latest/discord.html) if you don't have one already and invite the bot to your server, then:
1. Create `config.json` file and a `/recordings` directory at the root folder.
2. Paste the bot token (from [developer window](https://discord.com/developers/applications)) and any bot prefix into `config.json`, like so:
@@ -36,13 +36,17 @@ git clone https://github.com/chebro/discord-voice-recorder/
}
```
-You can now run the script in one of the following two ways:
+You can run the script in any of the following two ways:
### Run Locally
-Run `npm i` to download necessary `node_modules`, then run `npm start`, the bot should be online.
+1. Run `npm i` to download necessary `node_modules`.
-### Run as a Docker Container
+2. Run `npm start`.
+
+The bot should be online.
+
+### Run in Container
1. Build the docker image:
@@ -59,19 +63,17 @@ docker run \
dvr
```
-The bot should be online.
-
-3. To stop the container, run `docker stop `, you can restart it using `docker start `.
+The bot should be online.
### Bot Commands
-1. Start Recording : `enter `
++ Start Recording : `enter `
-2. Stop Recording : `exit`
++ Stop Recording : `exit`
## Managing the Output
-The output for each piece of audio stream is written to a unique file in [PCM format](https://en.wikipedia.org/wiki/Pulse-code_modulation) (48000 Hz, signed 16-bit little-endian, 2 channel [stereo]) and saved to the `/recordings` directory.
+The output for each piece of audio stream is written to a unique file in [PCM format](https://en.wikipedia.org/wiki/Pulse-code_modulation) (48000 Hz, signed 16-bit little-endian, 2 channel (stereo)) and saved to the `/recordings` directory.
### Merge Recording
@@ -81,16 +83,15 @@ To merge all output files to `/recordings/merge.pcm`, run:
node /bin/merge.js
```
-**Note:** Empty your `recordings` folder (and remove `merge.pcm`) after each session. Running `./bin/merge.js` otherwise, will dump large merge files.
+**Note:** Empty your `recordings` folder (and remove `merge.pcm`) after each session. Running `./bin/merge.js` otherwise will dump large merge files.
### Convert the Merged File to MP3
Head over to [FFmpeg.org](https://ffmpeg.org/download.html), and download executables for your OS; If you're on Windows, double-check if the FFmpeg bin is on your path. As discussed in issue [#3](https://github.com/chebro/discord-voice-recorder/issues/3), to convert pcm to mp3, run:
```
-ffmpeg -f s16le -ar 48000 -ac 2 -i merge.pcm output.mp3
+ffmpeg -f s16le -ar 48000 -ac 2 -i merge.pcm out.mp3
```
-
## Thanks
Special thanks to [@eslachance](https://github.com/eslachance) for the [gist](https://gist.github.com/eslachance/fb70fc036183b7974d3b9191601846ba). It is what inspired me to make this repo.