From a85d75df833e655df7a1d7d06f23d25d2ba04101 Mon Sep 17 00:00:00 2001 From: littleyoshi4 Date: Tue, 4 Oct 2016 22:43:46 -0500 Subject: [PATCH] Added README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..533a64b --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +Meant for use with the discord chat program available here: [Discord](https://discordapp.com/) + +**Requires** + * [Rapptz's discord python API](https://github.com/Rapptz/discord.py) + * Note: can be installed by running the following command as root: + ```python3 -m pip install -U discord.py``` + **See official documentation for further customization.* + +**Usage** + +1. Modify the final line in the script to include both your discord email and password +2. Run the script + * Note: a rather cryptic error can occor if you have 2 factor authentication enabled, [bug report here](https://github.com/Rapptz/discord.py/issues/235)) +3. As the same user which was used to log into the script, go to the desired channel you wish to save and type ```!yank``` which will start the scraping process +4. If successful, the file should be saved in the directory you ran the script in as .txt + * Note: This works with both server channels and private channels, however private conversions will save under the filename 'None.txt', while everything else will save under the name of the channel. + \ No newline at end of file