update README file

README.md

@@ -1,22 +1,26 @@
-#Description:
-The repo contains a python web-scraping application to minimum number of links between 2 given wiki pages
+#finLink:
+findLink is a python web-scraping application to minimum number of links between 2 given wiki pages
+
+[![Build Status](https://travis-ci.org/tranlyvu/find-link.svg?branch=master)](https://travis-ci.org/tranlyvu/find-link)
+
+#Using findLink:
+*   Downloading a [release](https://github.com/tranlyvu/find-link)
 
-#Usage:
-*	Sample
-	*	[sample](https://github.com/tranlyvu/findLink/sample.py)
-
 *	Quickstart
-	1.	Initializing class 'my_findLink""
+	1.	Initializing class 'findLink""
 	2.	Calling "search" method
 
+*	Sample
+	*	[sample](https://github.com/tranlyvu/findLink/sample.py)
+
 #Contribution
-Contributions are welcome! For bug reports or requests please submit an [issue](https://github.com/tranlyvu/findLink/issues).
+*  Join our [gitter] ( gitter.im/find-link) and Maillist
+*  [Release management](https://launchpad.net/findlink)    
+*  For any feature recommendation please register a [Blueprint](https://blueprints.launchpad.net/findlink)
+*  For bug reports or requests please submit an [issue](https://github.com/tranlyvu/find-link/issues)
 
-#Contact-info
-Feel free to contact me to discuss any issues, questions, or comments.
-*  Email: [email protected]
-*  Twitter: [@vutransingapore](https://twitter.com/vutransingapore)
-*  GitHub: [vutransingapore](https://github.com/tranlyvu)
+#Frequently Asked Questions
+The FAQs can be found on the project's [Wiki page](https://github.com/tranlyvu/find-link/wiki). Feel free to submit more questions to be answered and added to the page.
 
 #License
-See the LICENSE file for license rights and limitations (MIT).
+See the LICENSE file for license rights and limitations (Apache License 2.0).

requirements.txt

@@ -1,3 +1,7 @@
-bs4==4.3.2
-urllib2==2.7
-MySQLdb==1.3.7
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+
+
+beautifulsoup4
+MySQL-python

src/__init__.py

@@ -1,7 +1,17 @@
+"""finLink
 
+finlIkn is web-scraping application to find minimum number of links between two given wiki pages
+Beautiful Soup works with Python 2.7 and up.
+For more than you ever wanted to know about finLink, see the documentation:
+
+"""
+
+__author__ = "Tran Ly Vu ([email protected])"
+__version__ = "1.0.0"
+__copyright__ = "Copyright (c) 2016-2017 Tran Ly Vu"
+__license__ = "Apache License 2.0"
 
 __all__=[
 		'retrieveData',
 		'searchEngine'
-
 		]

src/findLink.py

@@ -4,7 +4,7 @@
 from searchEngine.searcher import searcher
 import MySQLdb	
 
-class my_findLink:
+class findLink:
 	def __init__(self,starting_url,ending_url,limit=6):
 		""" Main class of the application
 			

src/settings.py

@@ -1,3 +1,3 @@
-my_user='vutran'
-my_password='13061990'
+my_user=''
+my_password=''
 my_host="localhost"