Edit readme
This commit is contained in:
parent
1a842a395e
commit
c50f3a4190
82
README.md
82
README.md
|
@ -1 +1,83 @@
|
|||
# umbrello-bot
|
||||
An opensource telegram bot to know if you need to take the umbrella.
|
||||
|
||||
<img src="assets/screenshot.png" height="400">
|
||||
|
||||
|
||||
**Technologies**:
|
||||
|
||||
- Node.js
|
||||
- Telegraf.js
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
**umbrello-bot**
|
||||
|
||||
### 1. Search city
|
||||
Search the city id with:
|
||||
|
||||
```
|
||||
/search [city name]
|
||||
```
|
||||
|
||||
*example: `/search Roma`*
|
||||
|
||||
It will send back the cities id.
|
||||
|
||||
|
||||
### 2. Set the city
|
||||
Set the city wth:
|
||||
|
||||
```
|
||||
/set [city id]
|
||||
```
|
||||
|
||||
*example: `/set 3169070`. (3169070= Rome, IT)*
|
||||
|
||||
|
||||
### 3. Get the forecasts
|
||||
Get the forecasts with:
|
||||
```
|
||||
/get
|
||||
```
|
||||
|
||||
|
||||
## Installation
|
||||
### Step by step
|
||||
|
||||
1. Install Node.js and npm.
|
||||
2. Clone this repository.
|
||||
3. Install dependencies with `npm install`.
|
||||
4. Create a new bot with BotFather on Telegram
|
||||
5. Create env file or set environment variables (read: "Environment variables")
|
||||
6. Build the codewith `npm run build`.
|
||||
7. Launch the bot with `npm run serve`.
|
||||
|
||||
|
||||
#### Environment Variables
|
||||
```
|
||||
NODE_ENV=production
|
||||
TELEGRAM_TOKEN=token-here
|
||||
UMBRELLO_API_URL=url-here
|
||||
|
||||
DB_HOST=mongodb://host:port/db
|
||||
DB_USER=user
|
||||
DB_PASSWORD=pass
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Build Docker image
|
||||
```
|
||||
# docker build -t umbrello-bot:1.0 .
|
||||
# docker run umbrello-bot:1.0
|
||||
```
|
||||
|
||||
## License
|
||||
GPLv3
|
||||
|
||||
---
|
||||
Made with ❤️ by Francesco Esposito ([@frsposito](https://github.com/frsposito))
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 592 KiB |
Loading…
Reference in New Issue