From 455a298259bce8c17e920ead7fef347e1712b597 Mon Sep 17 00:00:00 2001
From: Alexandre <44178713+alexbelgium@users.noreply.github.com>
Date: Mon, 29 Nov 2021 10:41:53 +0100
Subject: [PATCH] Update README.md

---
 paperless_ng/README.md | 64 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)

diff --git a/paperless_ng/README.md b/paperless_ng/README.md
index 461124ec2..15d04301c 100644
--- a/paperless_ng/README.md
+++ b/paperless_ng/README.md
@@ -1,3 +1,28 @@
+# Home assistant add-on: Paperless NG
+
+[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
+
+[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
+
+![Supports 
+ Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield]
+![Supports smb mounts][smb-shield]
+
+_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
+
+[![Stargazers repo roster for @alexbelgium/hassio-addons](https://reporoster.com/stars/alexbelgium/hassio-addons)](https://github.com/alexbelgium/hassio-addons/stargazers)
+
+## About
+
+---
+
+[Paperless NG](https://github.com/qbittorrent/qBittorrent) is a cross-platform free and open-source BitTorrent client.
+This addon is based on the docker image from [linuxserver.io](https://www.linuxserver.io/).
+
+## Configuration
+
+---
+
 Options can be configured through two ways :
 - Addon options
 ```yaml
@@ -12,3 +37,42 @@ CONFIG_LOCATION : Location of the config.yaml (see below)
 - Config.yaml
 
 Custom env variables can be added to the config.yaml file referenced in the addon options. Full env variables can be found here : https://github.com/linuxserver/docker-paperless-ng. It must be entered in a valid yaml format, that is verified at launch of the addon.
+
+## Installation
+
+---
+
+The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
+
+1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
+   [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
+1. Install this add-on.
+1. Click the `Save` button to store your configuration.
+1. Set the add-on options to your preferences
+1. Start the add-on.
+1. Check the logs of the add-on to see if everything went well.
+1. Open the webUI and adapt the software options
+
+## Integration with HA
+
+No specific integration, it is a self hosted system
+
+## Support
+
+Create an issue on github
+
+## Illustration
+
+---
+
+![illustration](https://paperless-ng.readthedocs.io/en/latest/_images/documents-smallcards.png)
+
+[repository]: https://github.com/alexbelgium/hassio-addons
+[smb-shield]: https://img.shields.io/badge/smb-yes-green.svg
+[openvpn-shield]: https://img.shields.io/badge/openvpn-yes-green.svg
+[ingress-shield]: https://img.shields.io/badge/ingress-yes-green.svg
+[ssl-shield]: https://img.shields.io/badge/ssl-yes-green.svg
+[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
+[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
+[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
+[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg