formatting

README.md

@@ -2,24 +2,25 @@
   - SPDX-FileCopyrightText: 2014 Robin Appelman <robin@icewind.nl>
   - SPDX-License-Identifier: MIT
 -->
-SMB
-===
+
+# SMB
 
 [![CI](https://github.com/icewind1991/SMB/actions/workflows/ci.yaml/badge.svg)](https://github.com/icewind1991/SMB/actions/workflows/ci.yaml)
 [![codecov](https://codecov.io/gh/icewind1991/SMB/branch/master/graph/badge.svg?token=eTg0P466k6)](https://codecov.io/gh/icewind1991/SMB)
 
-PHP wrapper for `smbclient` and [`libsmbclient-php`](https://github.com/eduardok/libsmbclient-php)
+PHP wrapper for `smbclient` and
+[`libsmbclient-php`](https://github.com/eduardok/libsmbclient-php)
 
 - Reuses a single `smbclient` instance for multiple requests
 - Doesn't leak the password to the process list
 - Simple 1-on-1 mapping of SMB commands
 - A stream-based api to remove the need for temporary files
-- Support for using libsmbclient directly trough [`libsmbclient-php`](https://github.com/eduardok/libsmbclient-php)
+- Support for using libsmbclient directly trough
+  [`libsmbclient-php`](https://github.com/eduardok/libsmbclient-php)
 
-Examples
-----
+## Examples
 
-### Connect to a share ###
+### Connect to a share
 
 ```php
 <?php
@@ -35,10 +36,10 @@ $server = $serverFactory->createServer('localhost', $auth);
 $share = $server->getShare('test');
 ```
 
-The server factory will automatically pick between the `smbclient` and `libsmbclient-php`
-based backend depending on what is available.
+The server factory will automatically pick between the `smbclient` and
+`libsmbclient-php` based backend depending on what is available.
 
-### Using anonymous authentication ### 
+### Using anonymous authentication
 
 ```php
 $serverFactory = new ServerFactory();
@@ -46,7 +47,7 @@ $auth = new AnonymousAuth();
 $server = $serverFactory->createServer('localhost', $auth);
 ```
 
-### Using kerberos authentication ###
+### Using kerberos authentication
 
 There are two ways of using kerberos to authenticate against the smb server:
 
@@ -55,7 +56,8 @@ There are two ways of using kerberos to authenticate against the smb server:
 
 ### Using a server ticket
 
-Using a server ticket allows the web server to authenticate against the smb server using an existing machine account.
+Using a server ticket allows the web server to authenticate against the smb
+server using an existing machine account.
 
 The ticket needs to be available in the environment of the php process.
 
@@ -67,15 +69,18 @@ $server = $serverFactory->createServer('localhost', $auth);
 
 ### Re-using a client ticket
 
-By re-using a client ticket you can create a single sign-on setup where the user authenticates against
-the web service using kerberos. And the web server can forward that ticket to the smb server, allowing it
-to act on the behalf of the user without requiring the user to enter his password.
+By re-using a client ticket you can create a single sign-on setup where the user
+authenticates against the web service using kerberos. And the web server can
+forward that ticket to the smb server, allowing it to act on the behalf of the
+user without requiring the user to enter his password.
 
-The setup for such a system is fairly involved and requires roughly the following this
+The setup for such a system is fairly involved and requires roughly the
+following this
 
 - The web server is authenticated against kerberos with a machine account
 - Delegation is enabled for the web server's machine account
-- The web server is setup to perform kerberos authentication and save the ticket in it's environment
+- The web server is setup to perform kerberos authentication and save the ticket
+  in it's environment
 - Php has the krb5 extension installed
 - The client authenticates using a ticket with forwarding enabled
 
@@ -86,36 +91,36 @@ $auth->setTicket(KerberosTicket::fromEnv());
 $server = $serverFactory->createServer('localhost', $auth);
 ```
 
-### Upload a file ###
+### Upload a file
 
 ```php
 $share->put($fileToUpload, 'example.txt');
 ```
 
-### Download a file ###
+### Download a file
 
 ```php
 $share->get('example.txt', $target);
 ```
 
-### List shares on the remote server ###
+### List shares on the remote server
 
 ```php
 $shares = $server->listShares();
 
 foreach ($shares as $share) {
-	echo $share->getName() . "\n";
+    echo $share->getName() . "\n";
 }
 ```
 
-### List the content of a folder ###
+### List the content of a folder
 
 ```php
 $content = $share->dir('test');
 
 foreach ($content as $info) {
-	echo $info->getName() . "\n";
-	echo "\tsize :" . $info->getSize() . "\n";
+    echo $info->getName() . "\n";
+    echo "\tsize :" . $info->getSize() . "\n";
 }
 ```
 
@@ -135,20 +140,22 @@ fwrite($fh, 'bar');
 fclose($fh);
 ```
 
-**Note**: write() will truncate your file to 0bytes. You may open a writeable stream with append() which will point
-the cursor to the end of the file or create it if it does not exist yet. (append() is only compatible with libsmbclient-php)
+**Note**: write() will truncate your file to 0bytes. You may open a writeable
+stream with append() which will point the cursor to the end of the file or
+create it if it does not exist yet. (append() is only compatible with
+libsmbclient-php)
+
 ```php
 $fh = $share->append('test.txt');
 fwrite($fh, 'bar');
 fclose($fh);
 ```
 
-
 ### Using notify
 
 ```php
 $share->notify('')->listen(function (\Icewind\SMB\Change $change) {
-	echo $change->getCode() . ': ' . $change->getPath() . "\n";
+    echo $change->getCode() . ': ' . $change->getPath() . "\n";
 });
 ```
 
@@ -169,24 +176,30 @@ $options->setMaxProtocol(IOptions::PROTOCOL_SMB3);
 $serverFactory = new ServerFactory($options);
 ```
 
-Note, setting the protocol version is not supported with php-smbclient version 1.0.1 or lower.
+Note, setting the protocol version is not supported with php-smbclient version
+1.0.1 or lower.
 
 ### Customizing system integration
 
-The `smbclient` backend needs to get various information about the system it's running on to function
-such as the paths of various binaries or the system timezone.
-While the default logic for getting this information should work on most systems, it is possible to customize this behaviour.
+The `smbclient` backend needs to get various information about the system it's
+running on to function such as the paths of various binaries or the system
+timezone. While the default logic for getting this information should work on
+most systems, it is possible to customize this behaviour.
 
-In order to customize the integration you provide a custom implementation of `ITimezoneProvider` and/or `ISystem` and pass them as arguments to the `ServerFactory`. 
+In order to customize the integration you provide a custom implementation of
+`ITimezoneProvider` and/or `ISystem` and pass them as arguments to the
+`ServerFactory`.
 
 ## Testing SMB
 
 Use the following steps to check if the library can connect to your SMB share.
 
-1. Clone this repository or download the source as [zip](https://github.com/icewind1991/SMB/archive/master.zip)
+1. Clone this repository or download the source as
+   [zip](https://github.com/icewind1991/SMB/archive/master.zip)
 2. Make sure [composer](https://getcomposer.org/) is installed
 3. Run `composer install` in the root of the repository
 4. Edit `example.php` with the relevant settings for your share.
 5. Run `php example.php`
 
-If everything works correctly then the contents of the share should be outputted.
+If everything works correctly then the contents of the share should be
+outputted.