First commit: add .gitignore and update README

BoboTiG · BoboTiG · commit 933d919bda59 · 2013-07-01T20:21:44.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+src/
+tests/
+support.html
diff --git a/README.md b/README.md
@@ -1,4 +1,48 @@
-python-mss
-==========
+Python MSS
+===
+
+An attempt to create a full functionnal cross-platform multi-screen  
+shot module in _pure_ python using ctypes.
+
+Very basic, it will grab one screen shot by monitor or a screen shot  
+of all monitors and save it to an optimised/progressive JPEG file.
+
+MSS is for *Multi-Screen Shot*.
+
+Dependancies & requirements
+---
+
+Python. And that is all :)  
+MSS is writen in pure python, it uses ctypes.  
+ctypes has been introduced in Python 2.5, before it will need ctypes modules to be installed separately.
+
+Support
+---
+
+You can see the support table [here](https://tiger-222.fr/tout/python-mss/support.html).  
+Feel free to try MSS on a system we had not tested, and let report us by creating an [issue](https://github.com/BoboTiG/python-mss/issues).
+
+Usage
+---
+
+It is quite easy, just call a new instance of `MSS()` and then `save()`.  
+You can pass `oneshot=True` to create one screen shot of all monitors.
+
+    from mss import MSS
+    try:
+        mss = MSS()
+        # One shot per monitor
+        for filename in mss.save():
+            print('File "{0}" created.').format(filename)
+        # A shot to grab them all :)
+        filename = mss.save(oneshot=True)[0]
+        print('[Full] File "{0}" created.').format(filename)
+    except Exception as ex:
+        print(ex)
+
+Bonus
+---
+
+Just for fun ...  
+Show us your screen shot with all monitors in one file, we will update the [gallery](https://tiger-222.fr/tout/python-mss/galerie/) ;)
 
-Multi-Screen Shot: cross-plateform Python module using only pure python (ctypes) to grab screen shot. Created with the goal to support multi-screen and be light.
