Update README, Bump version to test workflow

README.md

@@ -6,7 +6,7 @@
   />
 </p>
 
-***
+---
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
@@ -15,20 +15,22 @@ Senko is the simplest **Over The Air** updater solution for your **Micropython**
 Senko synchronizes selected files on your microcontroller with the remote ones from **GitHub** repository.  
 I used Senko to automatically deploy the latest `master` branch to my ESP8266 sensors fleet.
 
->🚧 By all means, Senko is not the best implementation, but for my simple IoT projects, It was adequate!
+> 🚧 By all means, Senko is not the best implementation, but for my simple IoT projects, It was adequate!
 
 <br>
 
 ## 🛠 Operating Principle
+
 Every time `.fetch()` or `.update()` methods are called Senko compares **SHA1** hashes of local files with remote ones to determine if they are the same.
 
 If they are not, Senko saves remote files from **GitHub** repository to your microcontroller. This means you need to reboot to run the latest code.
 
->🚧 You are responsible for implementing a network connection and reboot strategy!
+> 🚧 You are responsible for implementing a network connection and reboot strategy!
 
 <br>
 
 ## 🔥 Installation
+
 Senko consists of a single `senko.py` module that you import.
 
 You can use **Ampy** or **WebREPL** to load `/senko/senko.py` module to your microcontroller:
@@ -37,49 +39,63 @@ You can use **Ampy** or **WebREPL** to load `/senko/senko.py` module to your mic
 sudo ampy -p /dev/ttyUSB0 put senko.py
 ```
 
+Or use **uPip** to install Senko from **PyPi**:
+
+```python
+import upip
+upip.install("micropython-senko")
+```
+
 <br>
 
 ## 🎉 Usage
+
 You should start by importing the module and creating a `Senko` object.
 
-You have to specify **URL** to the **GitHub** directory containing your code and **files** that you want to keep synchronized.
+You have to specify **user** with your GitHub username, **repo**, and **files** that you want to keep synchronized.
 
 ```python
 # boot.py
 import senko
 
-GITHUB_URL = "https://github.com/RangerDigital/senko/blob/master/examples/"
-OTA = senko.Senko(url=GITHUB_URL, ["boot.py", "main.py"])
+OTA = senko.Senko(
+  user="ocktokit", # Required
+  repo="octokit-iot", # Required
+  branch="master", # Optional: Defaults to "master"
+  working_dir="app", # Optional: Defaults to "app"
+  files = ["boot.py", "main.py"]
+)
 ```
 
+Or You can also specify **URL** to the **GitHub** directory containing your code and **files** that you want to keep synchronized.
+
 ```python
 # boot.py
 import senko
 
-OTA = senko.Senko(
-  user='ocktokit', # required
-  repo='octokit-iot', # required
-  branch='master', # defaults to 'master'
-  working_dir='app', # defaults to 'app'
-  files = ["boot.py", "main.py"]
-)
+GITHUB_URL = "https://github.com/RangerDigital/senko/blob/master/examples/"
+OTA = senko.Senko(url=GITHUB_URL, files=["boot.py", "main.py"])
 ```
+
 To get the **URL** simply click the `RAW` button on the one of the files that you want to track and then strip the name of that file from it.
 
->💡 You can even specify what branch Senko will update from!
+> 💡 You can even specify what branch Senko will update from!
 
 <br>
 
 ### Updating
+
 Then after connecting to Wi-Fi network call `OTA.update()`:
+
 ```python
 # boot.py
 import senko
 import machine
 import network
 
-GITHUB_URL = "https://github.com/RangerDigital/senko/blob/master/example/"
-OTA = senko.Senko(GITHUB_URL, ["boot.py", "main.py"])
+OTA = senko.Senko(
+  user="ocktokit", repo="octokit-iot", files = ["boot.py", "main.py"]
+)
 
 # Connect to Wi-Fi network.
 connect_wlan()
@@ -88,20 +104,23 @@ if OTA.update():
     print("Updated to the latest version! Rebooting...")
     machine.reset()
 ```
+
 This setup will try to keep `boot.py` and `main.py` updated every time microcontroller boots.
 
 <br>
 
 ### Fetching
+
 If you only want to check if the newer version of files exists call `OTA.fetch()`:
+
 ```python
 if OTA.fetch():
     print("A newer version is available!")
 else:
     print("Up to date!")
 ```
 
->💡 Check out a simple example of usage from `examples` directory!
+> 💡 Check out a simple example of usage from `examples` directory!
 
 <br>
 
@@ -114,4 +133,5 @@ Just fork this project from the `master` branch and submit a Pull Request (PR).
 <br>
 
 ## 📃 License
+
 This project is licensed under [GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/) .

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="micropython-senko",
-    version="2.0.3",
+    version="2.0.4",
     author="Jakub Bednarski",
     author_email="[email protected]",
     description="Simplest OTA update solution for your Micropython projects.",