update readme

Author: pscheit

README.md

@@ -1,3 +1,42 @@
 # webforge-utils
 
 [![Build Status](https://travis-ci.org/webforge-labs/webforge-utils.svg)](https://travis-ci.org/webforge-labs/webforge-utils)
+
+
+## whats included
+
+- DateTime and Time classes for an advanced (and more concise) interface for the PHP::DateTime classes
+- A full functional File and Directory implementation that abstracts a lot of PHP file funtions
+  - supports nearly every way to write a file path (and convert): 
+    - windows D:\www\something.php
+    - unix /some/path
+    - wrappers: vfs://some/file/topath
+    - windows cygin /cydrive/d/www/someting.php
+    - windows shares \\\\psc-laptop\shared\www\something.php
+    - unix style windows paths (sublime and others): /D/www/something.php
+  - copy dirs and files recursively
+  - find files recursively
+- Commonly used Exceptions with better semantics and debug output (FileNotFound, NotImplemented, Deprecated)
+- Some simple Utils to debug and dump variables
+- A bunch of useful String and Array functions
+
+## usage 
+
+  - [Dir and File API](docs/dir-and-file.md)
+
+## installation
+
+Use [Composer](http://getcomposer.org) to install.
+```
+composer require webforge/utils
+```
+
+## license
+
+Copyright (c) 2015 ps-webforge.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/dir-and-file.md

@@ -0,0 +1,42 @@
+# Dir and File
+
+Dir and File help you to do very common, often typed actions with php file utils. Notice: every directory has a trailing slash or backslash at its end per default. You have to construct those paths with trailing slash as well, unless you use `Dir::factoryTS`
+
+## usage
+```php
+$dir = new Dir('/my/root');
+
+$dir->getFile('index.php')->writeContents('<?php echo "hello world"; ')->copy(new File('index.html', $dir));
+```
+
+```php
+$dir->copy(Dir::createTemporary());
+```
+
+```php
+$file->move(new File(...));
+$file->copy(new File(...));
+$file->copy(Dir::factoryTS(__DIR__));
+```
+
+```php
+$file->getCreationTime();
+$file->getModificationTime()->format('d.m.Y H:i');
+$file->getAccessTime()->1i8n_format('d. F H:i');
+```
+
+In most of the cases you will work with libraries and other devs that do not trailslash their directoriese
+
+will return the path as string [w]ithout [t]railing [s]lash:
+```php
+$dir->wtsPath();
+```
+
+will return the path as string with trailing slash:
+```php
+$dir->getPath();
+```
+
+## umask and defaultMod
+
+For historical reasons the default permissions for a new Directory created by Webforge are 0644 (octal). To make webforge respekt your umask, configure it and set the environment variable `WEBFORGE_UMASK_SET` to 1. It then will call mkdir() with 0777 (octal) so that your umask is respected.