From 357b14131e2c2cafbeb368c6b8c1bbe59a18e40c Mon Sep 17 00:00:00 2001
From: mrfoxygmfr <mrfoxygmfr@sch9.ru>
Date: Mon, 31 Jan 2022 16:35:47 +0500
Subject: [PATCH] README added

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..70e388b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# Huffman archiver
+
+An archiver that uses Huffman code for compression
+
+## Building from source
+
+#### Prerequisite Tools
+
+* [Git](https://git-scm.com/download)
+* [Go (version 1.17 or later)](https://go.dev/dl)
+
+1. Install all prerequisite tools
+2. Clone this repository
+
+```bash
+git clone https://ashley.sch9.ru/git/mrfoxygmfr/huffman-archiver
+```
+
+3. Build executable binary
+
+```bash
+go build -o huffman main.go
+```
+
+## Usage
+
+#### Archiving
+
+To archive a file, use the command
+
+```bash
+./huffman encode <archive name> <file name>
+```
+
+where `<file name>` is the name of the file to be compressed, `<archive name>` is the name of the archive to be created.
+
+#### Unpacking
+
+To unpack a file, use the command
+
+```bash
+./huffman decode <archive name> <file name>
+```
+
+where `<archive name>` is the name of the archive to unpack, `<file name>` is the name of the file to save.