From 78a73134d6c63424747973ad12374819bea2445c Mon Sep 17 00:00:00 2001
From: Dmytro Stanchiev <git@dmytros.dev>
Date: Fri, 31 Oct 2025 11:52:34 -0400
Subject: [PATCH] add readme

Signed-off-by: Dmytro Stanchiev <git@dmytros.dev>
---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8426053
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# Moshy-rust: a simple Mosh wrapper with profile settings, but in Rust
+
+## Attributes
+
+<p>This is a rewrite of a project https://github.com/kiniou/moshy<br>
+The original idea belongs to [kiniou](https://github.com/kiniou).</p>
+
+## Introduction
+<p>Moshy is a simple <u>python</u> Rust script which allow a user to connect to mosh server with<br>
+different settings per hosts like port ranges or commands to run immediately once logged in.</p>
+
+## Installation
+
+```bash
+cargo install
+```
+
+## Configuration
+
+Moshy wraps mosh in order to use configuration profiles from the following path:
+
+```
+/etc/moshy.conf     # System configuration
+${HOME}/.moshy.conf # Per-user configuration
+```
+
+<p>You can select a profile by passing `hostname` argument and extra arguments<br>
+which will be executed to the remote mosh session.</p>
+
+The `hostname` parameter match configuration sections and can be formatted like the following:
+
+```
+hostname             - connect to a remote hostname
+user@hostname        - connect a specific user to connect with
+hostname:flavor
+user@hostname:flavor - 'flavor' is an arbitrary name that can be
+                       used to reference your commands.
+```
+
+<p>You can simply list configured profiles by using the list command and get more<br>
+information on profile configured.</p>
+