Commit eda7eef0 authored by EXL's avatar EXL
Browse files

Reorganize project and prepare to 1.0.7

Fix ReadMe files and other notes
parent a5fb6f65
The MIT License (MIT)
Copyright (c) 2015 Serg "EXL" Koles
Copyright (c) 2015-2020 EXL
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
......
Digest Bot
=============
==========
![Bot Screen](Images/DigestBotScreen.png)
Telegram digest bot for group chats.
Bot records all messages with the `#digest` tag and displays them on the `/digest` command.
Thanks to the creators of [node-telegram-bot-api](https://github.com/yagop/node-telegram-bot-api) and the creators of powerful and awesome JavaScript framework[Node.js](https://nodejs.org/en/)
Telegram digest bot for group chats. Final version is 1.0.7, deprecated in favor to [Digest](https://github.com/EXL/Digest) project.
Bot records all messages with the `#digest` tag and displays them on the `/digest` command. Thanks to the creators of [node-telegram-bot-api](https://github.com/yagop/node-telegram-bot-api) and the creators of [Node.js](https://nodejs.org/en/)powerful and awesome JavaScript framework.
## Install instructions
For example, GNU/Linux:
* Install the "Node.js" and the "npm" Node.js package manager;
* Install the **Node.js** and the `npm` Node.js package manager;
```sh
sudo apt-get install nodejs
......@@ -25,15 +25,19 @@ cd ~/Deploy/
git clone https://github.com/EXL/DigestBot DigestBotDeploy
```
* Install "node-telegram-bot-api", "request" and others modules into deploy directory;
* Install **node-telegram-bot-api**, **request** and others modules into deploy directory;
```sh
cd ~/Deploy/DigestBotDeploy/
npm install # or npm ci
```
* Write your token in "BOT_TOKEN_ACCESS.json" file.
* Write your token in *BOT_TOKEN_ACCESS.json* file.
* Run with `node DigestBot` or `nodejs DigestBot` and enjoy!
Please read [big tutorial (in Russian)](http://exlmoto.ru/writing-telegram-bots/) about creating various bots for Telegram.
## Additional information
* Please read [big tutorial (in Russian)](http://exlmoto.ru/writing-telegram-bots/) about creating various bots for Telegram.
* New [Digest](https://github.com/EXL/Digest) comprehensive project based on Spring Boot and [Java Telegram Bot API](https://github.com/pengrad/java-telegram-bot-api) implementation by [@pengrad](https://github.com/pengrad).
......@@ -5,6 +5,6 @@ Site for displaying the history of digests from database. The design and CSS of
## Install
* Edit config "config.php".
* Edit config *config.php* file.
Make sure that the database and PHP are working with UTF-8 (utf8mb4 for unicode smiles) charset.
Make sure that the database and PHP are working with UTF-8 (utf8mb4 for unicode emoji) charset.
......@@ -9,11 +9,11 @@ The utility for creating a database/table from digest backups. Messages are save
* Create database or table with `utf8mb4` and `utf8mb4_unicode_ci` charsets.
* Edit config "DataBaseConfig.json".
* Edit config *DataBaseConfig.json* file.
## Usage
1. Add digest post to DB:
1. Add digest post to database:
```bash
$ node ImportDigestToDB.js <backup-dir> <chat-id>
......@@ -31,4 +31,4 @@ $ node ImportDigestToDB.js <backup-dir> 0
$ node ImportDigestToDB.js <backup-dir> users
```
Make sure that the database is working with UTF-8 (utf8mb4 for unicode smiles) charset.
Make sure that the database is working with UTF-8 (utf8mb4 for unicode emoji) charset.
{
"name": "digestbot",
"version": "1.0.5",
"version": "1.0.7",
"description": "Telegram digest bot for group chats",
"keywords": [
"Telegram Bot",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment