add readme

1 files changed, 13 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..75fd1ec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# triumfalno #
+
+Специально для Русин-треда. 
+
+### Как пользоваться ###
+```
+./main.py decode --remove-junk
+```
+Опция `--remove-junk` удаляет мусорные слова из текстов перед обработкой. 
+
+В файле `data.json` лежат тексты и метаинформация, собранные с архивов двача и фейсбука. Кроме `pic` там ничего полезного нет. В папке `img` лежат связанные с текстами изображения.
+
+Работает на `Python 3`, рекомендуется установить модуль `termcolor` чтобы вывод был цветным.