Added README

willdurand · willdurand · commit b26ae4aac32e · 2011-12-22T19:43:09.000+01:00
diff --git a/src/Symfony/Component/Filesystem/README.md b/src/Symfony/Component/Filesystem/README.md
@@ -0,0 +1,29 @@
+Filesystem Component
+====================
+
+Filesystem provides basic utility to manipulate the file system:
+
+    use Symfony\Component\Filesystem\Filesystem;
+
+    $filesystem = new Filesystem();
+
+    $filesystem->copy($originFile, $targetFile, $override = false);
+
+    $filesystem->mkdir($dirs, $mode = 0777);
+
+    $filesystem->touch($files);
+
+    $filesystem->remove($files);
+
+    $filesystem->chmod($files, $mode, $umask = 0000);
+
+    $filesystem->rename($origin, $target);
+
+    $filesystem->symlink($originDir, $targetDir, $copyOnWindows = false);
+
+    $filesystem->makePathRelative($endPath, $startPath);
+
+    $filesystem->mirror($originDir, $targetDir, \Traversable $iterator = null, $options = array());
+
+    $filesystem->isAbsolutePath($file);
+
