diff --git a/src/index.html b/src/index.html new file mode 100644 index 0000000..32479aa --- /dev/null +++ b/src/index.html @@ -0,0 +1,68 @@ + + +
+# blek! QRGen + +Author: blek <me@blek.codes> +License: GPLv3-only (see 3) +Made with Rust and <3 +Source code: https://git.blek.codes/blek/qrgen + +--- + +This is a simple microservice that generates QR codes for you via HTTP API. +It has been originally developed for blek!File ( https://file.blek.codes ), +which source code is at https://git.blek.codes/blek/bfile . + +## 1. HTTP API Reference + +GET /{ QR Code text } + +Returns a QR code image with the desired text. It may be confusing that the +returned image is very small, but it is a simple measure to decrease the +bandwith usage on mobile devices. + +You can scale that image up with CSS, just like this: + +```css + +.qrcode-image { + width: 400px; + image-rendering: pixelated; /* This line "unblurs" the qr code */ + + padding: 60px; + background: white; +} + +``` + +## 2. Customizing the generated QR + +Unfourtunately, at the time I had no need to implement these features. PR's +are welcome as well as suggestions to the features. + +However, the default settings for a QR are as follows: + + Correction Level = M + Image Type = Grayscale PNG + PNG Compression = None + +## 3. License +This program 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. + +This program 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 this program. If not, see <https://www.gnu.org/licenses/>. + +--- +FCK/PTR + + +\ No newline at end of file diff --git a/src/main.rs b/src/main.rs index e839a23..8eb8cea 100644 --- a/src/main.rs +++ b/src/main.rs @@ -19,7 +19,7 @@ async fn main() { // Match any request and return hello world! let routes = warp::path::end() - .map(|| "Hello, World!") + .map(|| warp::reply::html(include_str!("index.html"))) .or( warp::path!(String) .and(