From ed6824885643c22172229fae4c83631642aeb408 Mon Sep 17 00:00:00 2001
From: RunasSudo <runassudo@yingtongli.me>
Date: Sun, 10 Dec 2017 23:27:37 +1030
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3679546
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# pyWSDscan
+
+Cross-platform open-source Python tool to interact with a network scanner using the Microsoft WSD (Web Services on Devices) WS-Scan protocol.
+
+Tested on a Fuji Xerox DocuPrint CM115w.
+
+## Example usage
+
+Replace `http://192.168.0.2:9867/ws2/` with the applicable URL for your network scanner.
+
+Basic usage:
+
+    ./main.py http://192.168.0.2:9867/ws2/ scan > out.jpg
+
+This will scan a document using the scanner's default settings.
+
+Specifying more options:
+
+    ./main.py http://192.168.0.2:9867/ws2/ scan --quality 95 --type Text --format exif --size a4 --source ADFDuplex --color BlackAndWhite1 --ppi 300 --region '10x20+3,4 cm' > out.jpg
+
+This will scan an A4 document from the duplex-capable Automatic Document Feeder using the text profile, at 300 pixels per inch. The region scanned is a 10 cm by 20 cm region, which is offset by 3 cm along the x-axis and 4 cm along the y-axis. The image will be scanned as 1 bit-per-pixel black and white, and stored as an Exif (JPEG) image at 95% quality.
+
+Specifying separate options for front and back pages (ADFDuplex only):
+
+    ./main.py http://192.168.0.2:9867/ws2/ scan --source ADFDuplex --color RGB24 BlackAndWhite1 --ppi 600 300 --region Default '10x20+3,4 cm' > out.jpg
+
+The front will be 24 bit-per-pixel RGB colour on the front side, at 600 pixels per inch, using the whole scan area. The back will be 1 bit-per-pixel black and white, at 300 pixels per inch, using the 10x20 cm region from earlier.