Better README

This commit is contained in:
Dominik Moritz Roth 2021-10-30 17:52:53 +02:00
parent 8147f64b4b
commit 59bab52160

View File

@ -13,11 +13,6 @@ Meuro's worth is equivalent to that of the euro on January 1st 2001 00:00 GMT.
What you find in this repo is a small python-libary that connects to the ecb to get historic inflation-data and computes the conversion-factor between € and µ for any given date (after Jan 1st 2001).
## Usage
You probably want to use this tool using the cli-interface which tries to understand requests in human language.
### For best Results:
To reference the currencies use €, eur, euro, e, E, or µ, meu, meuro, m, M;
Currencies should be an integer or have 2 digits after the point (.).
Dates should always be dd.mm.YYYY or dd.mm.yy
If no date is supplied (or understood) the current date is used.
### Examples:
#### ./meuro.py What is 200 eur in meuro
#### ./meuro.py I want to know how much 2000€ from 11.11.2011 are in meuro
@ -25,6 +20,11 @@ If no date is supplied (or understood) the current date is used.
#### ./meuro.py 50,000€ 10.10.2010
#### ./meuro.py 1000 meur 2055
#### ./meuro.py 3.14E 01.02.2003 12:34
### For best Results:
To reference the currencies use €, eur, euro, e, E, or µ, meu, meuro, m, M;
Currencies should be an integer or have 2 digits after the point (.).
Dates should always be dd.mm.YYYY or dd.mm.yy
If no date is supplied (or understood) the current date is used.
## Python-API
You can also import this libary from another python file
##### The provided functions are: