From 709be1d261d491c46bbe7731a4d137bcc36b9303 Mon Sep 17 00:00:00 2001 From: nck974 Date: Thu, 14 Sep 2023 23:16:30 +0200 Subject: [PATCH] [DOCUMENTATION] Update README.md with logo and description --- README.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d82059a..e2f60a9 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,24 @@ [![codecov](https://codecov.io/github/nck974/diogenes/branch/main/graph/badge.svg?token=XDI3M0M5AE)](https://codecov.io/github/nck974/diogenes) -- [Diogenes](#diogenes) - - [Usage](#usage) - - [Docker](#docker) - - [Development](#development) - - [Backend](#backend) - - [Run tests](#run-tests) - - [Coverage](#coverage) - - [Create backend docker container](#create-backend-docker-container) - - [Frontend](#frontend) - - [Create frontend docker container](#create-frontend-docker-container) - - [Reverse proxy](#reverse-proxy) +Logo + +Diogenes is an inventory web application designed to help you manage and keep track of your possessions at home. It is completely self-hosted, and no data is collected from users. You have the flexibility to easily migrate your data using the API, which is detailed in the Open API documentation provided by the backend server. + +This app is intended to assist you in cataloging everything you own, helping you avoid the clutter often associated with Diogenes Syndrome. + +The application goal is to provide a faster and more user-friendly alternative to managing your belongings compared to a plain Excel spreadsheet + +- [Usage](#usage) + - [Docker](#docker) +- [Development](#development) + - [Backend](#backend) + - [Run tests](#run-tests) + - [Coverage](#coverage) + - [Create backend docker container](#create-backend-docker-container) + - [Frontend](#frontend) + - [Create frontend docker container](#create-frontend-docker-container) + - [Reverse proxy](#reverse-proxy) ## Usage