Merge branch 'master' of https://github.com/jens-maus/carddav2fb

README.md

@@ -1,18 +1,19 @@
-## CardDAV contacts import for AVM FritzBox
+# CardDAV contacts import for AVM FRITZ!Box
 
 Features:
 
-* Allows to import CardDAV contacts (e.g. from 'owncloud') to an AVM FritzBox
-* No modification of the FRITZ!Box firmware (aka FritzOS) required
-* Multiple CardDAV accounts and "folders" can be specified 
+* Allows to import CardDAV-based VCard contacts (e.g. from 'owncloud') to a phonebook in a AVM FRITZ!Box
+* CardDAV import includes photo images specified in VCards
+* No modification of FRITZ!Box firmware (aka FRITZ!OS) required
+* Definition of multiple CardDAV accounts and "folders" possible
 
 **CAUTION: This script will overwrite your current contacts in the FritzBox without any warning!**
 
-### Information
+## Information
 
-This version of carddav2fb is a forked version from carlos22 with updates applied being published at http://www.ip-phone-forum.de/showthread.php?t=267477. In addition to being compatible to newer Fritz!OS versions it also features two fixes regarding OSX generated vCards.
+This version of carddav2fb is a forked version from carlos22 (https://github.com/carlos22/carddav2fb) with certain updates applied which had been published at http://www.ip-phone-forum.de/showthread.php?t=267477. In addition to being compatible to newer FRITZ!OS versions it also features a bunch of bug fixes.
 
-### Installation
+## Installation
 
  1. Use git to checkout carddav2fb from github
 
@@ -33,24 +34,24 @@ Now you should have everything setup and checked out to a 'carddav2fb' directory
 3. Make sure the telephone book you are going to update via carddav2fb exists on the FRITZ!Box, otherwise the upload will fail.
 4. Copy `config.example.php` to `config.php` and adapt it to your needs including setting the FRITZ!Box user settings.
 
-### Usage
+## Usage
 
-#### Ubuntu
+### Ubuntu
 
-1. Install PHP and PHP-Curl
+1. Install PHP5, PHP-curl and PHP-ftp module:
 
 		sudo apt-get install php5-cli php5-curl php5-ftp
 
-2. Open a Terminal and execute
+2. Open a Terminal and execute:
 
 		php carddav2fb.php
 
-#### Windows
+### Windows
 
 1. Download PHP from [php.net](http://windows.php.net/download/). Extract it to `C:\PHP`.
 2. Start -> cmd. Run `C:\PHP\php.exe C:\path\to\carddav2fb\carddav2fb.php`
 
-### config.php Example (owncloud)
+## config.php Example (owncloud)
 
 	$config['fritzbox_ip'] = 'fritz.box';
 	$config['fritzbox_user'] = '<USERNAME>';
@@ -64,3 +65,15 @@ Now you should have everything setup and checked out to a 'carddav2fb' directory
 	  'user' => '<USERNAME>',
 	  'pw' => '<PASSWORD>'
 	);
+
+## Note
+This script is using third-party libraries for downloading VCards from CardDAV servers based on the following packages
+* CardDAV-PHP (https://github.com/jens-maus/CardDAV-PHP.git)
+* FRITZ!Box-API-PHP (https://github.com/jens-maus/fritzbox_api_php.git)
+* VCard-Parser (https://github.com/jens-maus/vCard-parser.git)
+
+## License
+This script is released under Public Domain.
+
+## Authors
+Copyright (c) 2012-2015 Karl Glatz, Martin Rost, Jens Maus