Updated README.md

This commit is contained in:
Daniel Tyler 2016-10-04 22:46:22 -05:00 committed by GitHub
parent a85d75df83
commit 7e87d1fa84

View File

@ -3,14 +3,16 @@ Meant for use with the discord chat program available here: [Discord](https://di
**Requires** **Requires**
* [Rapptz's discord python API](https://github.com/Rapptz/discord.py) * [Rapptz's discord python API](https://github.com/Rapptz/discord.py)
* Note: can be installed by running the following command as root: * Note: can be installed by running the following command as root:
```python3 -m pip install -U discord.py``` ```python3 -m pip install -U discord.py```
**See official documentation for further customization.* **See official documentation for further customization.*
**Usage** **Usage**
1. Modify the final line in the script to include both your discord email and password 1. Modify the final line in the script to include both your discord email and password
2. Run the script 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)) * 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 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 <channel name>.txt 4. If successful, the file should be saved in the directory you ran the script in as <channel name>.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. * 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.