Merge pull request #15 from viordash/readme

Readme

README.md

@@ -1,3 +1,42 @@
-# ShareClipbrd
+## Sharing the clipboard between two computers
 
 [![.NET](https://github.com/viordash/ShareClipbrd/actions/workflows/dotnet.yml/badge.svg?branch=main)](https://github.com/viordash/ShareClipbrd/actions/workflows/dotnet.yml)
+
+ShareClipbrdApp - кросс-платформенная утилита, Windows/Linux(X11). 
+
+ShareClipbrdApp позволяет отправлять содержимое буфера обмена с одного компьютера на другой. 
+
+> первоначальная цель создания утилиты, была в том чтобы в целях безопасности, отказаться
+> от автоматической синхронизации буфера обмена при работе с
+> виртуальными машинами в Windows, отправка данных только по команде
+> оператора.
+
+Для отправки данных достаточно кликнуть на окно программы, *небольшой прямоугольник цвета морской волны*, и затем нажать Ctrl+V или правым кликом в контекстном меню выбрать Paste.
+
+![Main app window](https://github.com/viordash/ShareClipbrd/blob/readme/assets/Open%20settings.png)
+
+> В верхнем левом углу расположены индикаторы состояния соединения между партнерами.
+
+**Функции:**
+ - форматы данных, `текст`, `файлы\папки` и `изображения`.
+ - работа в локальной сети, по протоколу TCP/IP.
+ - три профиля сетевых настроек, для быстрого переключения между различными хостами.
+ - возможность автоматического поиска партнера, посредством протокола mDNS (Bonjour)
+
+**Запуск и установка.**
+
+Утилита поставляется как portable, достаточно скачать архив и распаковать. 
+
+В Windows запускать ShareClipbrdApp.exe.
+
+В Linux запускать ShareClipbrdApp.
+
+**Настройки соединения с партнером.**
+
+Правым кликом в окне программы, открыть контекстное меню, в разделе Settings в поле Host address ввести локальный IP адрес и через двоеточие номер порта, например `127.0.0.1:8090`. В поле Partner address ввести IP адрес и порт партнера, например `192.168.100.5:8091`. Вероятно указанные IP адреса и порты должны быть разрешены в Firewall.
+
+В большинстве случаев можно использовать возможность автоматического поиска партнера. В поле Host addres ввести параметр с форматом, который начинается с префикса "mdns:" затем произвольный идентификатор, например `mdns:win10_linux`, где `win10_linux` это идентификатор данной копии. Если необходимо указать конкретный номер порта, например для Firewall, то после идентификатора через двоеточие указывается номер порта, например `mdns:win10_linux:61002`.  В поле Partner address ввести mdns: с идентификатором партнера, номер порта не нужно вводить, например `mdns:linux_win10`.
+
+> При ошибке в настройках соединения может возникать окно с сообщением
+> об ошибке, при этом менять настройки можно продолжать без закрытия
+> окна с ошибкой.