From cdc485a5e9695a3011f435d5963c5e7084fbedd5 Mon Sep 17 00:00:00 2001
From: Oleg Chuev <91337563+OlegChuev@users.noreply.github.com>
Date: Tue, 20 Aug 2024 19:13:54 +0300
Subject: [PATCH] Update README.md

---
 README.md | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index ad1afb6..28d376d 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,17 @@
 # File system operations over Windows Remote Management (WinRM) for Ruby
+
 [![Build Status](https://travis-ci.org/WinRb/winrm-fs.svg?branch=master)](https://travis-ci.org/WinRb/winrm-fs)
 [![Gem Version](https://badge.fury.io/rb/winrm-fs.svg)](http://badge.fury.io/rb/winrm-fs)
 [![Build status](https://ci.appveyor.com/api/projects/status/wm6apa8ojfhfmwsf?svg=true)](https://ci.appveyor.com/project/winrb/winrm-fs)
 
 ## Uploading files
+
 Files may be copied from the local machine to the winrm endpoint. Individual files or directories, as well as arrays of files and directories may be specified. Data from a `StringIO` object may also be uploaded to a remote file.
+
 ```ruby
 require 'winrm-fs'
 
-connection = WinRM::Connection.new(...
+connection = WinRM::Connection.new(...)
 file_manager = WinRM::FS::FileManager.new(connection)
 
 # upload file.txt from the current working directory
@@ -29,11 +32,14 @@ file_manager.upload([
 ```
 
 ### Optimizing WinRM settings
+
 Since winrm-fs 1.0/winrm 2.0, files are uploaded using the PSRP protocol and transfer speeds are dramatically improved from previous versions. This is largely due to the fact that the size of chunks that can be transferred at one time are now governed by the `MaxEnvelopeSizekb` winrm configuration setting on the endpoint. This default to 500 on Windows 2012 R2 and 150 on Windows 2008 R2. You may experience much faster transfer rates on 2008 R2 by increasing this setting.
 
 ### Handling progress events
+
 If you want to implement your own custom progress handling, you can pass a code
-block and use the proggress data that `upload` yields to this block:
+block and use the progress data that `upload` yields to this block:
+
 ```ruby
 file_manager.upload('c:/dev/my_dir', '$env:AppData') do |bytes_copied, total_bytes, local_path, remote_path|
   puts "#{bytes_copied}bytes of #{total_bytes}bytes copied"
@@ -53,20 +59,20 @@ first.
 3. Run the unit and integration tests (bundle exec rake integration)
 4. Commit your changes (git commit -am "Added a sweet feature")
 5. Push to the branch (git push origin my_feature_branch)
-6. Create a pull requst from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
+6. Create a pull request from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
 
 ### Running the tests
 
 We use Bundler to manage dependencies during development.
 
-```
-$ bundle install
+```bash
+bundle install
 ```
 
 Once you have the dependencies, you can run the unit tests with `rake`:
 
-```
-$ bundle exec rake spec
+```bash
+bundle exec rake spec
 ```
 
 To run the integration tests you will need a Windows box with the WinRM service properly configured. Its easiest to use the Vagrant Windows box in the Vagrantilfe of this repo.
@@ -76,6 +82,7 @@ To run the integration tests you will need a Windows box with the WinRM service
 3. Run `bundle exec rake integration`
 
 ## WinRM-fs Authors
+
 * Shawn Neal (https://github.com/sneal)
 * Matt Wrock (https://github.com/mwrock)