From 87d30db8bed3c65277f8f3dfbbd807b293ff373f Mon Sep 17 00:00:00 2001
From: marcsello <marcsello@sch.bme.hu>
Date: Wed, 7 Mar 2018 11:54:43 +0100
Subject: [PATCH] Added README

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bec8c33
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Fancy BTC
+Ez egy kicsike kis script, ami szép ASCII artban kiírja, a BTC egészre kerekített árát forintban.
+
+### Kompatibilitás
+A script Python 2-vel és 3-mal is kompatibilis.
+### Függőségek
+A script függőségei a requirements.txt fájlban találhatóak.
+A következő parancsal telepíthetőek:
+````
+pip install -r requirements.txt
+````
+### Futtatás
+A futtatáshoz elég a következő parancsot használni:
+````
+python btc.py
+````
+
+### Adatforrás
+A script az aktuális árfolyam adatokat a coindesk.com API-t használva tölti le minden futásnál.
+
+Lásd: https://www.coindesk.com/api/
+
+### A pontosságról
+A script nem matematikai értelemben vett kerekítést használ, hanem string művelettel levágja a tizedespont utáni részt. Az API sajátosságai miatt ez egyszerűbb.
\ No newline at end of file
-- 
GitLab