Add README.md

README.md

@@ -0,0 +1,62 @@
+## ScanBridge: An easy to use android app for scanning documents
+
+This project is a modern android app written in Kotlin for using network-attached scanners
+supporting the
+eSCL/AirScan protocol. The eSCL protocol allows for driverless usage of network scanners and is
+supported by most modern
+scanning devices.
+In the background, Jetpack Compose is used for the UI and Material 3 design is followed.
+
+<!-- TODO: Screenshots -->
+
+## Features
+
+- Discover scanners in your network using mDNS
+- Scan multiple pages, rearrange and delete them
+- Export scanned documents to your device as images or PDFs
+
+## Downloads
+
+## Dependencies
+
+This project uses eSCLKt, a Kotlin library for using network-attached scanners supporting the
+eSCL/AirScan protocol.
+
+## Building
+
+Gradle is used as the build system. To build an APK, run the following command:
+
+```./gradlew assembleRelease```
+
+To just build and test ScanBridge run the following command:
+
+```./gradlew build```
+
+## Bugs & feature requests
+
+You can ask questions, report bugs or submit feature requests on the GitHub issue tracker. Please
+provide a detailed
+description of the problem and if possible, android logcats and stacktraces. In some cases
+the ScannerCapabilities.xml can also be useful
+
+## Contributions
+
+Contributions are welcome, and it would be amazing if you want to help. Refer to
+the Contribution Guidelines for more information.
+
+## License
+
+Copyright (C) 2024 Christian Nagel and contributors.
+
+ScanBridge is free software: you can redistribute it and/or modify it under the terms of
+the GNU General Public License as published by the Free Software Foundation, either
+version 3 of the License, or (at your option) any later version.
+
+ScanBridge is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with ScanBridge.
+If not, see <https://www.gnu.org/licenses/>.
+
+SPDX-License-Identifier: GPL-3.0-or-later