From e4d29996910c3bdef8ee2cb45c6ea8d10c8aeebe Mon Sep 17 00:00:00 2001
From: Andrei Malashenko <97245660+SquaddieSnowball@users.noreply.github.com>
Date: Mon, 25 Dec 2023 15:32:28 +0300
Subject: [PATCH] docs: update README.md

---
 README.md | 30 ++++++++++++++++++++++++------
 1 file changed, 24 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index ff9c66c..e523550 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,26 @@
-# Librarians assistant
+# Librarians Assistant
 
-Represents a librarians assistant. Key features:
+![CI](https://github.com/SquaddieSnowball/LibrariansAssistant/actions/workflows/ci.yml/badge.svg)
 
-- **SQL Server database support**
-- **Custom ORM**
-- **Support for exporting data in Text/Excel formats.**
-- **User interface created using the Windows Forms framework**
+**Librarians Assistant** is a simple assistant in library management. Key features:
+
+- Accounting for borrowed books;
+- Sort and filter existing records;
+- Export data to various formats.
+
+## How to use
+
+### Requirements
+
+- An instance of **Microsoft SQL Server** installed on the host machine;
+- Available database name `library` on the DBMS instance, which will be used when running the application.
+
+### Setup steps
+
+- Configure connection settings in the `Application → Settings → Connection` section;
+- Check the `If the database is not found, create a new empty one` checkbox in the `Application → Settings → Additional` section so that the database is created automatically if it is missing;
+- Go to `Application → Connect to database` to display data.
+
+## License
+
+**Librarians Assistant** is licensed under the [MIT license](LICENSE.txt).