From ef0826a64fbd2988a1271bddb19c154e925c47f2 Mon Sep 17 00:00:00 2001 From: Ailothaen Date: Thu, 6 Sep 2018 21:00:08 +0200 Subject: [PATCH] Updating readme --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a21fe59..5be0842 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,28 @@ # ailotime An useful Discord bot for timezones and daylight stuff. -(Readme will be wrote when I will no longer feel lazy to do so :p -Check the wiki for help.) \ No newline at end of file +![Icon](http://ailothaen.fr/d/ailotime-256.png "Icon") +*(icon drawn by [Applestream](https://www.deviantart.com/applestream "Applestream"))* + +## What it can do? +- Telling the time at any city or timezone in the world +- Converting a time to another timezone +- Displaying info about the sun (sunset, sunrise, solar noon...) + +See the wiki for reference. + +## Getting your own install + +ailotime runs on Python 3.6. + +- Place all these files in a folder +- Run `pip install -r requirements.txt` to install dependencies +- Get a bot token on Discord API and write it in `run.py` +- Execute `run.py` ; after some loading, the bot should be up and running. + +## Invite + +I am providing a link for inviting ailotime. However, I am hosting it on my (small) server, so if someday the bot becomes too popular, I will maybe not be able to handle it. + +[Click here](https://discordapp.com/oauth2/authorize?&client_id=466678005926723584&scope=bot&permissions=2048 "Click here") to invite ailotime on your Discord server! +