Update docs, changelog & contribution guide, bumping v2.0.0

.github/CONTRIBUTING.md

@@ -25,12 +25,13 @@ We accept contributions via pull requests on [GitHub](http://github.com/hollodot
 
 ## Running tests
 
+Before running the tests, make sure the redis-server instance is running.
+
 ```bash
+$ docker-compose up -d
 $ php vendor/bin/phpunit.phar -c build/
 ```
 
-This includes a code coverage report in HTML and Clover XML.
-
 ## Analyze code
 
 ```bash

CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a CHANGELOG](http://keepachangelog.com).
 
+## [2.0.0] - 2018-04-03
+
+### Added
+
+ * Prettified view of compact JSON string values + raw JSON view
+ * Ability to use deeplinks to a specific database of a server
+ * Realtime monitor for connected clients and input/output in KB/sec.
+ * Favicons
+
+### Changed
+
+ * Migrated UI to bootstrap v4
+ * Database select becomes scrollable, if list exceeds the 400px
+ * Simplified installation 
+
 ## [1.1.3] - 2017-01-03
 
 ### Fixed
@@ -43,6 +58,8 @@ This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a CH
 
 First stable release.
 
+[2.0.0]: https://github.com/hollodotme/readis/compare/v1.1.3...v2.0.0
+[1.1.3]: https://github.com/hollodotme/readis/compare/v1.1.2...v1.1.3
 [1.1.2]: https://github.com/hollodotme/readis/compare/v1.1.1...v1.1.2
 [1.1.1]: https://github.com/hollodotme/readis/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/hollodotme/readis/compare/v1.0.1...v1.1.0

README.md

@@ -7,6 +7,10 @@
 
 A web interface to read data from redis server(s)
 
+## Public demo
+
+**[See the public demo on readis.hollo.me](https://readis.hollo.me)**
+
 ## Features
 
  * Setup / Selection for multiple redis servers
@@ -16,7 +20,7 @@ A web interface to read data from redis server(s)
  * Listing of found keys with variable limit
  * Basic information about keys
  * Viewing the content of keys and hash keys
- * Prettyfied JSON view, if value is a JSON string 
+ * Prettified JSON view, if value is a compact JSON string
  * Listing of slow logs
  * Table with all the current server instance information / stats
  * Table with all the current server configs
@@ -26,6 +30,7 @@ A web interface to read data from redis server(s)
 
  * Webserver (nginx, apache2, etc.)
  * PHP >= 7.1 with phpredis extension
+ * [composer](https://getcomposer.org)
 
 ## Installation
 
@@ -34,14 +39,13 @@ Assuming you'll install re<sup style="color: #ff0000;">a</sup>dis under `/var/ww
 1. SSH into your webserver.
 2. `$ git clone https://github.com/hollodotme/readis.git /var/www/readis`
 3. `$ cd /var/www/readis`
-4. `$ git checkout v1.1.3`
-5. `$ sh build/tools/update_tools.sh`
-6. `$ php build/tools/composer.phar update -o -v`
+4. `$ git checkout v2.0.0`
+6. `$ composer install -a --no-dev --no-interaction`
 7. `$ cp config/app.sample.php config/app.php`
-8. Set up the baseUrl in `config/app.php` (Should be the full http-URL with path, **without trailing slash**) 
+8. Set up the baseUrl in `config/app.php` (Should be the full HTTP URL with path, e.g. `https://www.example.com/readis/`) 
 9. `$ cp config/servers.sample.php config/servers.php`
 10. Set up all server instances in `config/servers.php`
-11. Set up your webserver having a VHost pointing to `/var/www/readis/public`  
+11. Set up your webserver VHost with document root `/var/www/readis/public`  
 
 ### Sample app configuration 
 
@@ -127,7 +131,7 @@ server {
 
 	location ~ \.php$ {
 		fastcgi_split_path_info ^(.+\.php)(/.+)$;
-		fastcgi_pass unix:/var/run/php5-fpm.sock;
+		fastcgi_pass unix:/var/run/php/php7.1-fpm.sock;
 		fastcgi_index index.php;
 		include fastcgi_params;
 	}
@@ -136,6 +140,15 @@ server {
 
 **That's it.**
 
-## Public demo
+## Run locally
+
+In order to run re<sup style="color: #ff0000;">a</sup>dis locally, follow these steps:
 
-**[See the public demo on readis.hollo.me](http://readis.hollo.me)**
+1. `$ git clone https://github.com/hollodotme/readis.git`
+2. `$ cd readis/`
+3. `$ composer update -o`
+4. `$ cp config/app.sample.php config/app.php` 
+5. `$ cp config/servers.sample.php config/servers.php`
+6. `$ php -S 127.0.0.1:8080 -t public/` (starts local webserver)
+7. `$ docker-compose up -d` (starts redis-server instance on `localhost:6379`)
+8. Open: http://127.0.0.1:8080