steffo/greed
steffo/greed
1
Fork 0
mirror of https://github.com/Steffo99/greed.git synced 2024-11-22 05:54:18 +00:00
Code Activity

Improve README

Browse source
This commit is contained in:
Steffo 2020-03-01 23:51:35 +01:00
parent eea3623475
commit 16e6b16fb0
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,9 +1,11 @@
# greed # greed
A customizable Telegram shop bot, developed as a project for the final exam. A customizable Telegram shop bot, developed as a project for the final exam.
![](https://img.shields.io/badge/version-beta-blue.svg) ![](https://img.shields.io/badge/version-beta-blue.svg) ![](https://img.shields.io/badge/maintenance-passively--maintained-yellowgreen)
## Requirements ## Requirements
* Python 3.6 (or higher) * Python 3.6 (or higher)
* The packages specified in `requirements.txt` (install with `pip install -r requirements.txt`) * The packages specified in `requirements.txt` (install with `pip install -r requirements.txt`)
* An Internet connection * An Internet connection
@ -12,6 +14,7 @@ A customizable Telegram shop bot, developed as a project for the final exam.
* _Optional: a [sentry.io](https://sentry.io) token_ * _Optional: a [sentry.io](https://sentry.io) token_
## Installation ## Installation
1. Download the project files through `git clone https://github.com/Steffo99/greed.git` or [this link](https://github.com/Steffo99/greed/archive/master.zip). 1. Download the project files through `git clone https://github.com/Steffo99/greed.git` or [this link](https://github.com/Steffo99/greed/archive/master.zip).
2. Install the project requirements with `pip install -r requirements.txt` 2. Install the project requirements with `pip install -r requirements.txt`
3. Run `python -OO core.py` to generate the configuration file. 3. Run `python -OO core.py` to generate the configuration file.
@ -23,10 +26,19 @@ Ensure the `is_template` field is set to `no`.
8. Open Telegram, and send a `/start` command to your bot to be promoted to administrator. 8. Open Telegram, and send a `/start` command to your bot to be promoted to administrator.
## Usage ## Usage
All the bot features are available through Telegram.
All the bot features are available through Telegram.
As the administrator, you can add new products, check the placed orders, create new transactions and generate .csv log files. As the administrator, you can add new products, check the placed orders, create new transactions and generate .csv log files.
Users will be able to add credit to their wallet, place orders and contact you in case they require assistance. Users will be able to add credit to their wallet, place orders and contact you in case they require assistance.
## Documentation ## Documentation
`greed` currently does not have a documentation page, but you can try to read the [paper](https://docs.google.com/document/d/1f4MKVr0B7RSQfWTSa_6ZO0LM4nPpky_GX_qdls3EHtQ/edit?usp=sharing) (in Italian) I wrote for my final Scuola Superiore exam about it. `greed` currently does not have a documentation page, but you can try to read the [paper](https://docs.google.com/document/d/1f4MKVr0B7RSQfWTSa_6ZO0LM4nPpky_GX_qdls3EHtQ/edit?usp=sharing) (in Italian) I wrote for my final Scuola Superiore exam about it.
## Forks
> Please note that @Steffo99, the developer of `greed`, does not endorse any of these forks.
### Bitcoin - Blockonomics
[DarrenWestwood](https://github.com/DarrenWestwood) is currently maintaining a [`greed`](https://github.com/DarrenWestwood/greed) fork with **Bitcoin support** through [Blockonomics](https://www.blockonomics.co/).