From 42c9863680080727380887e8606d28f1a8cd4eaa Mon Sep 17 00:00:00 2001
From: Bukk94 <st46557@student.upce.cz>
Date: Sun, 9 Aug 2020 02:38:16 +0200
Subject: [PATCH] Added readme

---
 README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dd99710
--- /dev/null
+++ b/README.md
@@ -0,0 +1,72 @@
+# Print service library (PSL)
+
+[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)
+[![GitHub Release](https://img.shields.io/github/release/Bukk94/PrintServiceLibrary.svg?style=flat)]()  
+[![Build Status](https://travis-ci.com/Bukk94/PrintServiceLibrary.svg?token=XTeWt6KEyExzbH1iNFWD&branch=master)](https://travis-ci.com/Bukk94/PrintServiceLibrary)
+
+This library servers as interface into printer's communication. 
+User is able to communicate with various connection interfaces using single API interface.
+
+API is able to communicate using:
+- USB port
+- LPT (Parallel port)
+- COM (Serial port)
+- Network connection (TCP/IP)
+
+PSL was mainly developed for Zebra printers using ZPL language. 
+But basic communication interface should work with any kind of printer and language as long as you follow standard printer's structure and langauge.
+
+### ZPL dependant methods
+
+These methods are only for printers that supports ZPL language.
+- `UploadFontToPrinter`
+- `ListPrinterMemory`
+- `GetPrinterFreeMemory`
+- `PreviewZPLPrint`
+
+# Code Examples
+
+## Printing using USB port
+
+```csharp
+string zplCommands = "^XA^FO100,153^FDTest Text to Print^FS^XZ";
+IPrintService printService = new PrintService();
+
+// Sends zplCommands to printer called "my printer" 
+// using the USB port. Printer will print 5 copies.
+printService.PrintUSB(zplCommands, "my printer", 5);
+```
+
+## Printing using TCP/IP
+
+```csharp
+string zplCommands = "^XA^FO100,153^FDTest Text to Print^FS^XZ";
+IPrintService printService = new PrintService();
+
+// Sends zplCommands to printer on IP 192.168.1.1:9100
+printService.PrintNetwork(zplCommands, System.Net.IPAddress.Parse("192.168.1.1"), 9100);
+```
+
+## Getting list of local printers
+```csharp
+IPrintService printService = new PrintService();
+
+// Loads all locally installed printers and return list of their names
+printService.LoadInstalledPrinters();
+```
+
+## Neodynamic integration
+
+PSL API has [Neodynamic ThermalLabel SDK](https://www.neodynamic.com/products/printing/thermal-label/sdk-vb-net-csharp/download/) 
+integration. If you do have Neodynamic licence key, you can pass it in 
+`PrintService` constructor and call methods like `PreviewZPLPrint`.
+
+These methods further enhances Neodynamic ZPL code generation from raw XML template by locally 
+previewing ZPL commands that will get send to the printer or by local data binding without needing communication with the printer.
+
+You can use these commands regardless of Neodynamic SDK licence but beware that "TRIAL" logo will be embedded in the ZPL commands.
+
+
+### Licensing
+
+PSL API is licensed under the MIT license (more in [LICENSE.MD](https://github.com/Bukk94/PrintServiceLibrary/blob/master/LICENSE)).
\ No newline at end of file