Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SquaddieSnowball authored Dec 25, 2023
1 parent ad766da commit e4d2999
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit e4d2999

Please sign in to comment.