Add README

Author: lxndio

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Alexander Korn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,19 @@
+# paperless-asn-index
+
+A simple web app that allows the user to generate a printable document index with ASN numbers from documents in a [Paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) instance. To achieve this, the app uses the Paperless-ngx API. This can be useful when filing documents in a folder sorted by ASN numbers. In this case, a printed index can provide reference for finding documents in case of any technical problems with the corresponding Paperless-ngx instance.
+
+![A screenshot showing all available options.](docs/options-screenshot.jpg)
+
+## Usage
+
+### Rust
+
+If you have the Rust compiler installed on your system, you can simply clone this repository and run `cargo build` to obtain an executable which can be used to locally run the web app on your system.
+
+### Docker
+
+You can use the provided Docker image to run the web app inside of a Docker container.
+
+## Warning
+
+This web app is in an early stage of development and is provided "as is" without any warranty under the terms of the attached license.