Update of README.md

funilrys · Jun 15, 2018 · 4e294bf · 4e294bf
1 parent a97a454
commit 4e294bf
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 8 deletions.
diff --git a/PyFunceble/__init__.py b/PyFunceble/__init__.py
@@ -74,7 +74,7 @@
 from PyFunceble.production import Production
 
 CURRENT_DIRECTORY = getcwd() + directory_separator
-VERSION = "0.80.1.dev-beta"
+VERSION = "0.80.2.dev-beta"
 
 CONFIGURATION_FILENAME = ".PyFunceble.yaml"
 

diff --git a/README.md b/README.md
@@ -11,20 +11,27 @@ PyFunceble is the little sister of [Funceble](https://github.com/funilrys/funceb
 
 Its main objective is to get and the return domains and IPs availability by generating an accurate result based on results from WHOIS, NSLOOKUP and HTTP status codes.
 
-In its daily usage, PyFunceble is mostly used to clean `hosts` files or blocklist. Indeed, it is possible because PyFunceble generates a list of all `ACTIVE` domains or IPs but in the same time, it creates by default a database of the `INACTIVE` domains or IPs so we can retest them overtime automatically at the next execution.
+PyFunceble is running actively and daily with the help of Travis CI under 60+ repositories. It is used to clean or test the availability of data which are present in hosts files, list of IP, list of domains, blocklists or even AdBlock filter lists. 
 
-PyFunceble is running actively and daily with the help of Travis CI under 60+ repositories. It is used to clean or test the availability of data which are present in hosts files, list of IP, list of domains, blocklists or even AdBlock filter lists.
+Indeed, it is possible because PyFunceble generates a list of all `ACTIVE` domains or IPs but in the same time, it creates by default a database of the `INACTIVE` domains or IPs so it can retest them overtime automatically at the next execution.
 
 * * *
 
-## :star2::book: Wiki as place to be! :book::star2:
+## :star2::book: Documentation as place to be! :book::star2:
 
-Want to know more about **PyFunceble**? All information to know can be found on the [wiki](https://github.com/funilrys/PyFunceble/wiki)!
+Want to know more about **PyFunceble**? 
+We invite you to read the documenation at https://pyfunceble.readthedocs.io!
 
-You can get a copy of the wiki with the following:
+### Local copy of the documentation
+
+Want a local copy ? We get you covered!
+
+Simply run the following and enjoy the documentation!
 
 ```shell
-$ git clone https://github.com/funilrys/PyFunceble.wiki.git
+$ cd docs/
+$ make html
+$ chromium _build/html/index.html # Chromium or whatever browser you use.
 ```
 
 ## Main Features

diff --git a/version.yaml b/version.yaml
@@ -1,4 +1,4 @@
-current_version: 0.80.1.dev-beta
+current_version: 0.80.2.dev-beta
 deprecated: [0.0.0, 0.0.1, 0.65.0, 0.67.1, 0.68.0, 0.69.3, 0.69.5, 0.70.4, 0.71.2,
     0.72.7, 0.73.1, 0.74.5, 0.75.1, 0.76.2, 0.77.0, 0.78.0, 0.79.1]
 force_update: