feat: added Documentation

ambimax · Mar 7, 2023 · b9b932d · b9b932d
1 parent 0be5126
commit b9b932d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/docs/remotes/README.md b/docs/remotes/README.md
@@ -1,2 +1,3 @@
 # Remotes
-- [Sftp File](sftp-file.md)
+- [Sftp File](sftp-file.md)
+- [Ftp File](ftp-file.md)
diff --git a/docs/remotes/ftp-file.md b/docs/remotes/ftp-file.md
@@ -0,0 +1,21 @@
+# Ftp File
+Class: [FtpFile](/src/Remote/FtpFile.php)
+
+## Difference to Base File
+### Ftp File creation
+```php
+use Ambimax\File\Remote\FtpFile;
+use Ambimax\File\FileMode;
+
+$ftoFile = new FtpFile(
+    hostname: 'example.com',
+    username: 'user',
+    password: 'password123',
+    filePath: 'foo/bar/baz.txt',
+    mode: FileMode::R,
+    overwrite: true // optional, default = false
+);
+```
+
+### Rename/Move
+The implementation of rename and move of FtpFile do not reopen the file.