Add Readme.markdown

android/Readme.markdown

@@ -0,0 +1,73 @@
+QR Code generator library - Android
+================================
+
+
+Introduction
+------------
+
+This project aims to be the best, clearest QR Code generator library. The primary goals are flexible options and absolute correctness. Secondary goals are compact implementation size and good documentation comments.
+
+Features
+--------
+
+Core features:
+
+* Significantly shorter code but more documentation comments compared to competing libraries
+* Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
+* Output format: Raw modules/pixels of the QR symbol
+* Detects finder-like penalty patterns more accurately than other implementations
+* Encodes numeric and special-alphanumeric text in less space than general text
+* Open-source code under the permissive MIT License
+
+Manual parameters:
+
+* User can specify minimum and maximum version numbers allowed, then library will automatically choose smallest version in the range that fits the data
+* User can specify mask pattern manually, otherwise library will automatically evaluate all 8 masks and select the optimal one
+* User can specify absolute error correction level, or allow the library to boost it if it doesn't increase the version number
+* User can create a list of data segments manually and add ECI segments
+
+Optional advanced features:
+
+* Encodes Japanese Unicode text in kanji mode to save a lot of space compared to UTF-8 bytes
+* Computes optimal segment mode switching for text with mixed numeric/alphanumeric/general/kanji parts
+
+More information about QR Code technology and this library's design can be found on the project home page.
+
+
+Examples
+--------
+
+```java
+import android.graphics.Bitmap;
+import android.graphics.Color;
+
+public class QRCodeGenerator {
+
+    public Bitmap generate(String content) {
+        QrCode qr = QrCode.encodeText(content, QrCode.Ecc.HIGH);
+        int scale = 8;
+
+        int size = qr.size * scale;
+
+        Bitmap bitmap = Bitmap.createBitmap(size, size, Bitmap.Config.ARGB_8888);
+
+        for (int x = 0; x < size; x++) {
+            for (int y = 0; y < size; y++) {
+                boolean isDark = qr.getModule(x / scale, y / scale);
+                int color;
+                if (isDark) {
+                    color = Color.BLACK;
+                } else {
+                    color = Color.WHITE;
+                }
+
+                bitmap.setPixel(x, y, color);
+            }
+        }
+
+        return bitmap;
+    }
+}
+```
+
+More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/java/QrCodeGeneratorDemo.java .