diff --git a/README.md b/README.md index c8d8b49..89cf6cf 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,14 @@ Gun Manager is a web application for managing a gun inventory, built with Go and Vue. It allows users to add, edit, and delete gun records, as well as view them in a user-friendly interface. +This application is designed to help gun enthusiasts and collectors keep track of their firearms, including details such +as make, model, caliber, and photos of each gun. + +Great for insurance purposes, personal inventory management, or simply for enthusiasts who want to keep a detailed +record of their collection. + ## Features + - Add, edit, and delete gun records - View gun records in a table - Search and filter gun records @@ -14,8 +21,11 @@ and delete gun records, as well as view them in a user-friendly interface. ## Running the Application -To run the Gun Manager application, you need to have Docker installed on your machine. The application uses a SQLite database to store gun records. +To run the Gun Manager application, you need to have Docker installed on your machine. The application uses a SQLite +database to store gun records. + ## Prerequisites + - Docker installed on your machine - A directory named `data` in the current working directory to store the SQLite database file