Skip to content

Commit eda7eef

Browse files
committed
Reorganize project and prepare to 1.0.7
Fix ReadMe files and other notes
1 parent a5fb6f6 commit eda7eef

File tree

8 files changed

+19
-15
lines changed

8 files changed

+19
-15
lines changed
File renamed without changes.
File renamed without changes.

LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015 Serg "EXL" Koles
3+
Copyright (c) 2015-2020 EXL
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
Digest Bot
2-
=============
2+
==========
33

44
![Bot Screen](Images/DigestBotScreen.png)
55

6-
Telegram digest bot for group chats.
7-
Bot records all messages with the `#digest` tag and displays them on the `/digest` command.
8-
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/)
6+
Telegram digest bot for group chats. Final version is 1.0.7, deprecated in favor to [Digest](https://github.com/EXL/Digest) project.
7+
8+
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.
99

1010
## Install instructions
1111

1212
For example, GNU/Linux:
1313

14-
* Install the "Node.js" and the "npm" Node.js package manager;
14+
* Install the **Node.js** and the `npm` Node.js package manager;
1515

1616
```sh
1717
sudo apt-get install nodejs
@@ -25,15 +25,19 @@ cd ~/Deploy/
2525
git clone https://github.com/EXL/DigestBot DigestBotDeploy
2626
```
2727

28-
* Install "node-telegram-bot-api", "request" and others modules into deploy directory;
28+
* Install **node-telegram-bot-api**, **request** and others modules into deploy directory;
2929

3030
```sh
3131
cd ~/Deploy/DigestBotDeploy/
3232
npm install # or npm ci
3333
```
3434

35-
* Write your token in "BOT_TOKEN_ACCESS.json" file.
35+
* Write your token in *BOT_TOKEN_ACCESS.json* file.
3636

3737
* Run with `node DigestBot` or `nodejs DigestBot` and enjoy!
3838

39-
Please read [big tutorial (in Russian)](http://exlmoto.ru/writing-telegram-bots/) about creating various bots for Telegram.
39+
## Additional information
40+
41+
* Please read [big tutorial (in Russian)](http://exlmoto.ru/writing-telegram-bots/) about creating various bots for Telegram.
42+
43+
* 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).

Stuff/DigestHistorySite/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ Site for displaying the history of digests from database. The design and CSS of
55

66
## Install
77

8-
* Edit config "config.php".
8+
* Edit config *config.php* file.
99

10-
Make sure that the database and PHP are working with UTF-8 (utf8mb4 for unicode smiles) charset.
10+
Make sure that the database and PHP are working with UTF-8 (utf8mb4 for unicode emoji) charset.

Stuff/ImportDigestsToDB/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ The utility for creating a database/table from digest backups. Messages are save
99

1010
* Create database or table with `utf8mb4` and `utf8mb4_unicode_ci` charsets.
1111

12-
* Edit config "DataBaseConfig.json".
12+
* Edit config *DataBaseConfig.json* file.
1313

1414
## Usage
1515

16-
1. Add digest post to DB:
16+
1. Add digest post to database:
1717

1818
```bash
1919
$ node ImportDigestToDB.js <backup-dir> <chat-id>
@@ -31,4 +31,4 @@ $ node ImportDigestToDB.js <backup-dir> 0
3131
$ node ImportDigestToDB.js <backup-dir> users
3232
```
3333

34-
Make sure that the database is working with UTF-8 (utf8mb4 for unicode smiles) charset.
34+
Make sure that the database is working with UTF-8 (utf8mb4 for unicode emoji) charset.
File renamed without changes.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "digestbot",
3-
"version": "1.0.5",
3+
"version": "1.0.7",
44
"description": "Telegram digest bot for group chats",
55
"keywords": [
66
"Telegram Bot",

0 commit comments

Comments
 (0)