From 920116f2e135e8a3591c80390fc9d4e4c6b8814f Mon Sep 17 00:00:00 2001
From: Profitroll <47523801+profitrollgame@users.noreply.github.com>
Date: Thu, 22 Sep 2022 18:31:12 +0200
Subject: [PATCH] Improved README

---
 README.md | 55 ++++++++++++++++++++++++++++---------------------------
 1 file changed, 28 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index 8db944f..e6af89c 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,24 @@
 # PythonRMV
 
-Small module that makes your journey with RMV REST API somehow easier.
+Small module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.
 
-# Get started
+# Requirements
 
-As you can guess you need to have RMV API key. You can get it for free on the [RMV website](https://opendata.rmv.de/site/start.html).
-After that you also need to have Python3. I've tested all of that on Python 3.7.9 and Python 3.9.13.
-Other versions should work too but I simply did not test it. Second python is not supported because why should it be.
-Don't forget to install git. Of course you can download the repo without it but it's simply faster to use git.
+* RMV API key (Get it [here](https://opendata.rmv.de/site/start.html))
+* Python3 (Tested versions are 3.7.9 and 3.9.13)
+* git (Only for installation from source)
 
 # Installation
 
-If you have all the listed in [Get started](#get-started), then let's begin.
+If you have everything listed in [requirements](#requirements), then let's begin.
 
-1. `git clone https://git.end-play.xyz/profitroll/PythonRMV.git`
-2. `cd PythonRMV`
-3. `python -m pip install -r requirements.txt`
+### Variant 1:
+1. `python -m pip install pyrmv`
 
-Done. You can now use everything that lays in PythonRMV.
+### Variant 2:
+1. `git clone https://git.end-play.xyz/profitroll/pyrmv.git`
+2. `cd pyrmv`
+3. `python setup.py install`
 
 # Frequently Asked Questions
 
@@ -28,29 +29,29 @@ Done. You can now use everything that lays in PythonRMV.
 ## Why are there raw versions and formatted ones?
 
 For the purposes of my projects I don't really need all the stuff RMV gives (even though it's not much).
-I only need some specific things and the rest I don't even need. However I do understand that in some
-cases other users may find those methods quite useful so I implemented them too.
+I only need some specific things. However I do understand that in some cases other users may find
+those methods quite useful so I implemented them as well.
 
 
 ## Some methods work slightly different
 
-Can be. Not all the arguments written may work perfectly because I simply did not test them all.
-Some of them may be irrelevant in my use-case and the others are used quite rare at all.
+Can be. Not all function arguments written may work perfectly because I simply did not test each and
+every request. Some of arguments may be irrelevant in my use-case and the others are used quite rare at all.
 Just [make an issue](https://git.end-play.xyz/profitroll/PythonRMV/issues/new) and I'll implement it correct when I'll have some free time.
 
 ## Documentation is not perfectly clear
 
-Of course docs cannot be perfect in the format of python docstring, especially if I also don't always
-know how things should correctly work so that's why you get HAFAS API docs together with your
-RMV API key. Just use my functions in connection with those docs, if you want to build something
-actually sophisticated. But remember, that I wrote all of that without sophistication in mind.
+Of course docs cannot be perfect as a python docstring, especially if sometimes I don't
+know how things should correctly work. That's why you get HAFAS API docs in addition to your
+RMV API key. Just use my functions together with those docs, if you want to build something
+really sophisticated. However I'm not sure whether RMV supports that many HAFAS features publicly.
 
 # To-Do
-[ ] arrivalBoard (boardArrival)  
-[ ] departureBoard (boardArrival)  
-[*] himsearch (himSearch)  
-[ ] journeyDetail  
-[*] location.nearbystops (stopByCoords)  
-[*] location.name (stopByName)  
-[ ] recon  
-[*] trip (findRoute)  
\ No newline at end of file
+- [ ] arrivalBoard (boardArrival)  
+- [ ] departureBoard (boardArrival)  
+- [x] himsearch (himSearch)  
+- [ ] journeyDetail  
+- [x] location.nearbystops (stopByCoords)  
+- [x] location.name (stopByName)  
+- [ ] recon  
+- [x] trip (findRoute)  
\ No newline at end of file