diff --git a/README.md b/README.md
index 6c95bf27..f6be27cb 100644
--- a/README.md
+++ b/README.md
@@ -10,10 +10,13 @@ It offers over 50 different methods to fetch data from sources like Alexa, Googl
A variety of *(private as well as enterprise)* SEO tools have been built using SEOstats.
+---
+
## Dependencies
SEOstats requires PHP version 5.3 or greater and the PHP5-CURL and PHP5-JSON extensions.
+---
## Installation
The recommended way to install SEOstats is [through composer](http://getcomposer.org).
@@ -26,6 +29,7 @@ To install SEOstats, just create the following `composer.json` file
}
and run the `php composer.phar install` (Windows: `composer install`) command in path of the `composer.json`.
+---
#### Step-by-step example:
If you haven't installed composer yet, here's the easiest way to do so:
@@ -40,7 +44,6 @@ user@host:~/> mv /path/given/by/composer-installer/composer.phar /usr/local/bin/
# (Note, you need to re-login your terminal for the change to take effect.)
user@host:~/> echo 'alias composer="php /usr/local/bin/composer.phar"' >> ~/.profile
```
-
If you have installed composer, follow these steps to install SEOstats:
```
# Create a new directory and cd into it:
@@ -59,16 +62,17 @@ Installing dependencies (including require-dev)
Writing lock file
Generating autoload files
-# You're done. For a quick start, you can now
-# copy the example files to the install directory:
+# You're done. For a quick start, you can now copy the example files to the install directory:
user@host:/path/to/seostats> cp ./vendor/seostats/seostats/example/*.php ./
# Your SEOstats install directory should look like this now:
user@host:/path/to/seostats> ls -1
-composer.json
-composer.lock
-get-alexa-graphs.php
+
+> composer.json
+> composer.lock
+> get-alexa-graphs.php
get-alexa-metrics.php
+
get-google-pagerank.php
get-google-pagespeed-analysis.php
get-google-serps.php
@@ -79,36 +83,39 @@ get-sistrix-visibilityindex.php
get-social-metrics.php
vendor
```
-
+
+
+
+---
+
#### Use SEOstats without composer
If composer is no option for you, you can still just download the [`SEOstats.zip`](https://github.com/eyecatchup/SEOstats/archive/master.zip) file of the current master branch (version 2.5.2) and extract it. However, currently [there is an issues with autoloading](https://github.com/eyecatchup/SEOstats/issues/49) and you need to follow the instructions in the comments in the example files in order to use SEOstats (or download zip for the development version of SEOstats (2.5.3) [here](https://github.com/eyecatchup/SEOstats/archive/dev-253.zip)).
+---
## Usage
### TOC
-* Configuration
+* configuration
* Brief Example of Use
* Alexa Methods
- * Alexa Traffic Metrics
- * Alexa Traffic Graphs
+* Alexa Traffic Metrics
+* Alexa Traffic Graphs
* Google Methods
- * Toolbar Pagerank
- * Pagespeed Service
- * Websearch Index
- * SERP Details
+* Toolbar Pagerank
+* Pagespeed Service
+* Websearch Index
+* SERP Details
* Mozscape Methods
* Open Site Explorer Methods
* SEMRush Methods
- * Domain Reports
- * Graphs
+* Domain Reports
+* Graphs
* Sistrix Methods
- * Visibility Index
+* Visibility Index
* Social Media Methods
-
-
### Configuration
There're two configuration files to note:
@@ -172,7 +179,6 @@ catch (SEOstatsException $e) {
```
More detailed examples can be found in the `./example` directory.
-
## SEOstats Alexa Methods
@@ -223,7 +229,6 @@ More detailed examples can be found in the `./example` directory.
// Returns HTML code for the 'search visits'-graph, using specific graph dimensions of 320*240 px.
print Alexa::getTrafficGraph(6, 0, 320, 240);
```
-
## SEOstats Google Methods
@@ -274,7 +279,7 @@ More detailed examples can be found in the `./example` directory.
// within the first 1000 results for a Google web search for 'keyword'.
print_r ( Google::getSerps('keyword', 1000, $url) );
```
-
+
## SEOstats Mozscape Methods
@@ -300,7 +305,6 @@ More detailed examples can be found in the `./example` directory.
// of the root domain of the URL to rank well in search engine results.
print Mozscape::getDomainAuthority();
```
-
## SEOstats Open Site Explorer (by MOZ) Methods
@@ -343,7 +347,6 @@ More detailed examples can be found in the `./example` directory.
$ose->totalLinks->unit . ') - ' . // String - "Total Links"
$ose->totalLinks->descr . PHP_EOL; // String - Result value description
```
-
## SEOstats SEMRush Methods
@@ -385,7 +388,7 @@ More detailed examples can be found in the `./example` directory.
// specific graph dimensions of 320*240 px and specific graph colors (black lines and red dots for data points).
print SemRush::getDomainGraph(5, 0, 'de', 320, 240, '000000', 'ff0000');
```
-
+
## SEOstats Sistrix Methods
@@ -397,7 +400,7 @@ More detailed examples can be found in the `./example` directory.
// @link http://www.sistrix.com/blog/870-sistrix-visibilityindex.html
print Sistrix::getVisibilityIndex();
```
-
+
## SEOstats Social Media Methods
@@ -453,8 +456,7 @@ More detailed examples can be found in the `./example` directory.
// Returns the total count of URL shares via VKontakte
print Social::getVKontakteShares();
```
-
-
+---
## License
(c) 2010 - 2016, Stephan Schmitz eyecatchup@gmail.com