fred.boniface/barcodes
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add explaination of formatted options to help

Browse Source
This commit is contained in:
Fred Boniface 2023-09-04 12:28:07 +01:00
parent 5e1cf45c58
commit d07ccd7038
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
templates/help.html
View File

@ -34,4 +34,17 @@
<p><code>content</code> should be the value you wish the barcode to display. This should be a string and may not accept all characters - that is dependent on the barcode type.</p> <p><code>content</code> should be the value you wish the barcode to display. This should be a string and may not accept all characters - that is dependent on the barcode type.</p>
<p>The response will be a PNG image</p> <p>The response will be a PNG image</p>
<h2>Formatted Barcodes</h2>
<p>Formatted barcodes are under development, this API endpoint <code>/generate/format</code> will produce a QR, Aztec or Datamatrix barcode with one of the following formats:</p>
<ul>
<li>WiFi Network</li>
<li>Contact (vCard)</li>
<li>Contact (MeCard)</li>
<li>Event (VCS)</li>
<li>Event (ICS)</li>
<li>Phone Number</li>
</ul>
<p>Note that URLs have no special formatting and can be produced as plain text barcodes using the <code>/generate</code> endpoint</p>
{{ end }} {{ end }}

3
templates/index.html
View File

@ -4,4 +4,7 @@
{{ end }} {{ end }}
{{ define "body" }} {{ define "body" }}
<div>
<p>Generation Options</p>
</div>
{{ end }} {{ end }}