Better documentation

andalugeeks · Apr 20, 2019 · 0ed680d · 0ed680d
1 parent e047458
commit 0ed680d
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,10  1,46 @@
-# Andaluh Telegram Transcriptor
 # Andaluh Telegram Bot
 [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
 
 Transliterate your spanish to andaluh EPA using this telegrma bot.
 
 <img width="459" alt="andaluh-slack about" src="https://github.com/andalugeeks/andaluh-telegram/blob/master/img/andaluhbot.png?raw=true">
 
 ## Table of Contents
 
 - [Installation](#installation)
 - [Roadmap](#roadmap)
 - [Support](#support)
 - [Contributing](#contributing)
 
 ## Installation
 
 You need to setup 2 environment variables to integrate with Telegram:
 
 - `APIURL`: URl for your [andaluh-api](https://github.com/andalugeeks/andaluh-api) instance. You can use ours as well https://api.andaluh.es/epa
 - `TOKEN`: Create your bot with [Telegram's BotFather](https://core.telegram.org/bots) to retrieve your TOKEN
 
 Running direclty:
 
 ```
 $ pip install -r requirements.txt
 $ APIURL=https://api.andaluh.es/epa TOKEN=GET_YOURS_WITH_TELEGRAM_BOTFATHER python app/andaluhbot.py
 ```
 
 Or dockerised:
 
 ```
 $ docker-compose up --build -d
 ```
 
 ## Roadmap
 
 * Add a new command to exaplain how a transliteration is done, rule by rule. For educationan purposes.
 * Add a new command to retrieve andalugeeks memes. For fun!
 
 ## Support
 
 Please [open an issue](https://github.com/andalugeeks/andaluh-telegram/issues/new) for support.
 
 ## Contributing
 
-Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and open a pull request.
 Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and open a pull request.
diff --git a/app/__init__.py b/app/__init__.py
@@ -0,0  1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 ###
 # 
 # Copyright (c) 2018 EPA
 # Authors : J. Félix Ontañón <[email protected]>
diff --git a/app/wsgi.py b/app/wsgi.py
@@ -1,2  1,9 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 ###
 # 
 # Copyright (c) 2018 EPA
 # Authors : J. Félix Ontañón <[email protected]>
 
 from app.andaluhbot import main
 main()