diff --git a/README.md b/README.md index d9e68ab..194a97f 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,20 @@ -MediaWikiAnalysis +Media-Wiki-Analysis ================= -MediaWiki Analysis Tool to gather information about pages, changes and people in MediaWiki based websites. +* MediaWiki Analysis Tool to gather information about pages, changes and people in MediaWiki based websites. -Usage +Usage:- ===== 1. Create an empty database to be used by us: - +``` bash $ echo "CREATE DATABASE mwdb CHARACTER SET utf8 COLLATE utf8_unicode_ci" | mysql -u root - +``` 1. Install required dependencies - +``` bash $ pip install -e . - +``` 1. Run analysis on a website: - +``` bash $ python mediawiki_analysis.py --database mwdb --db-user root --url +```