Rewrite README.md a bit

Some changes are for clarity and punctuation consistency. `+` instead of
`>` to show "this version or later" as `+` is what's typically used for
this purpose. or/and → and/or as the former form is rather uncommon.
This commit is contained in:
AttemptToCallNil 2020-11-25 15:13:08 +00:00
parent 39b0d37f35
commit 4c6d01ec15

View file

@ -1,21 +1,21 @@
## Overview ## ## Overview ##
*Recent changes Goat compatible Discord webhook* is a project created to track changes on the wiki directly on Discord. *Recent changes Goat compatible Discord webhook* is a project created to track changes on MediaWiki wikis directly on Discord.
**Screenshots** of the script in action can be found [on the wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Presentation). **Screenshots** of the script in action can be found [on the wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Presentation).
### Features ### ### Features ###
* Fetch recent changes from MediaWiki wiki or/and Discussions from Fandom wikis and send them to Discord channel using a webhook * Fetch recent changes from a MediaWiki wiki and/or Discussions from Fandom wikis and send them to a Discord channel using a webhook
* Two appearance modes - embed and compact * Two appearance modes embed and compact
* Send daily overviews, that show general information about wiki activity * Send daily overviews that show general information about wiki activity
* Supports multiple languages (included EN, PL, BR, RU, FR, UK) * Supports multiple languages (included EN, PL, BR, RU, FR, UK)
* Re-sends missed edits after start * Re-sends missed edits after start
* Very customizable * Very customizable
### Dependencies ### ### Dependencies ###
* **Python 3.6>** * **Python 3.6+**
* requests 2.18.4> * requests 2.18.4+
* beautifulsoup 4.6.0> * beautifulsoup 4.6.0+
* schedule 0.5.0> * schedule 0.5.0+
* lxml 4.2.1> * lxml 4.2.1+
### settings.json ### ### settings.json ###
[Explanation for settings](https://gitlab.com/piotrex43/RcGcDw/wikis/settings.json) [Explanation for settings](https://gitlab.com/piotrex43/RcGcDw/wikis/settings.json)
@ -39,7 +39,7 @@ Thank you!
[![Translation status](https://weblate.frisk.space/widgets/rcgcdw/-/multi-auto.svg)](https://weblate.frisk.space/engage/rcgcdw/?utm_source=widget) [![Translation status](https://weblate.frisk.space/widgets/rcgcdw/-/multi-auto.svg)](https://weblate.frisk.space/engage/rcgcdw/?utm_source=widget)
### Other extensions/compatible programs ### ### Other extensions/compatible programs ###
* [Wiki Utilities](https://github.com/Sidemen19/Wiki-Utilities) - an integration allowing administrator to execute revert/block or delete actions on the wiki using reactions in messages created by RcGcDw/RcGcDb. Author: [Sidemen19](https://github.com/Sidemen19) * [Wiki Utilities](https://github.com/Sidemen19/Wiki-Utilities) an integration that allows wikis administrators to revert edits, block editors, and delete pages on the wiki by reacting to messages created by RcGcDw/RcGcDb. Author: [Sidemen19](https://github.com/Sidemen19)
### Wiki ### ### Wiki ###
For more information, check the [wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Home)! For more information, check the [wiki](https://gitlab.com/piotrex43/RcGcDw/wikis/Home)!