Skip to content

Commit 709be1d

Browse files
authored
[DOCUMENTATION] Update README.md with logo and description
1 parent 351f597 commit 709be1d

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,24 @@
22

33
[![codecov](https://codecov.io/github/nck974/diogenes/branch/main/graph/badge.svg?token=XDI3M0M5AE)](https://codecov.io/github/nck974/diogenes)
44

5-
- [Diogenes](#diogenes)
6-
- [Usage](#usage)
7-
- [Docker](#docker)
8-
- [Development](#development)
9-
- [Backend](#backend)
10-
- [Run tests](#run-tests)
11-
- [Coverage](#coverage)
12-
- [Create backend docker container](#create-backend-docker-container)
13-
- [Frontend](#frontend)
14-
- [Create frontend docker container](#create-frontend-docker-container)
15-
- [Reverse proxy](#reverse-proxy)
5+
<img src="ng-diogenes/src/assets/logo/logo_transparent.png" alt="Logo" width="300">
6+
7+
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.
8+
9+
This app is intended to assist you in cataloging everything you own, helping you avoid the clutter often associated with Diogenes Syndrome.
10+
11+
The application goal is to provide a faster and more user-friendly alternative to managing your belongings compared to a plain Excel spreadsheet
12+
13+
- [Usage](#usage)
14+
- [Docker](#docker)
15+
- [Development](#development)
16+
- [Backend](#backend)
17+
- [Run tests](#run-tests)
18+
- [Coverage](#coverage)
19+
- [Create backend docker container](#create-backend-docker-container)
20+
- [Frontend](#frontend)
21+
- [Create frontend docker container](#create-frontend-docker-container)
22+
- [Reverse proxy](#reverse-proxy)
1623

1724
## Usage
1825

0 commit comments

Comments
 (0)