Merge pull request #10 from ShaynAli/dev

Version 1.0

.gitignore

@@ -16,4 +16,4 @@ pyvenv.cfg
 !.gitkeep
 
 # Install files
-vsa_compression.egg-info/
+voronoi_compression.egg-info/

compression.py

@@ -163,7 +163,7 @@ def main(in_image, out_image, progress=False):
 if __name__ == '__main__':
     import argparse
 
-    parser = argparse.ArgumentParser(description='Uses Voronoi cells to compress and decompress an image')
+    parser = argparse.ArgumentParser(description='Uses Voronoi cells to compress and decompress an image.')
     parser.add_argument('-p', '--progress', action='store_true',
                         help='show progress bars')
     parser.add_argument('-i', '--in-image', required=True,

license.md

@@ -0,0 +1,46 @@
+The license for this work is subject to change without notice.
+
+Email shayaan.syed.ali@gmail.com for commercial licensing.
+
+# End-User License Agreement (EULA) of VSA Compression
+
+This End-User License Agreement ("EULA") is a legal agreement between you and Shayaan Syed Ali
+
+This EULA agreement governs your acquisition and use of our VSA Compression software ("Software") directly from Shayaan Syed Ali or indirectly through an authorized reseller or distributor (a "Reseller").
+
+Please read this EULA agreement carefully before completing the installation process and using the VSA Compression software. It provides a license to use the VSA Compression software and contains warranty information and liability disclaimers.
+
+If you register for a free trial of the VSA Compression software, this EULA agreement will also govern that trial. By clicking "accept" or installing and/or using the VSA Compression software, you are confirming your acceptance of the Software and agreeing to become bound by the terms of this EULA agreement.
+
+If you are entering into this EULA agreement on behalf of a company or other legal entity, you represent that you have the authority to bind such entity and its affiliates to these terms and conditions. If you do not have such authority or if you do not agree with the terms and conditions of this EULA agreement, do not install or use the Software, and you must not accept this EULA agreement.
+
+This EULA agreement shall apply only to the Software supplied by Shayaan Syed Ali herewith regardless of whether other software is referred to or described herein. The terms also apply to any updates, supplements, Internet-based services, and support services for the Software, unless other terms accompany those items on delivery. If so, those terms apply. This EULA was created by EULA Template for VSA Compression and modified by Shayaan Syed Ali.
+
+## License Grant
+
+Shayaan Syed Ali hereby grants you a personal, non-transferable, non-exclusive licence to use the VSA Compression software on your devices in accordance with the terms of this EULA agreement.
+
+You are permitted to load the VSA Compression software (for example a PC, laptop, mobile or tablet) under your control. You are responsible for ensuring your device meets the minimum requirements of the VSA Compression software.
+
+You are not permitted to:
+
+  * Reproduce, copy, distribute, resell or otherwise use the Software for any commercial purpose
+  * Allow any third party to use the Software on behalf of or for the benefit of any third party
+  * Use the Software in any way which breaches any applicable local, national or international law
+  * Use the Software for any purpose that Shayaan Syed Ali considers is a breach of this EULA agreement
+
+## Intellectual Property and Ownership
+
+Shayaan Syed Ali shall at all times retain ownership of the Software as originally downloaded by you and all subsequent downloads of the Software by you. The Software (and the copyright, and other intellectual property rights of whatever nature in the Software, including any modifications made thereto) are and shall remain the property of Shayaan Syed Ali.
+
+Shayaan Syed Ali reserves the right to grant licences to use the Software to third parties.
+
+## Termination
+
+This EULA agreement is effective from the date you first use the Software and shall continue until terminated. You may terminate it at any time upon written notice to Shayaan Syed Ali.
+
+It will also terminate immediately if you fail to comply with any term of this EULA agreement. Upon such termination, the licenses granted by this EULA agreement will immediately terminate and you agree to stop all access and use of the Software. The provisions that by their nature continue and survive will survive any termination of this EULA agreement.
+
+## Governing Law
+
+This EULA agreement, and any dispute arising out of or in connection with this EULA agreement, shall be governed by and construed in accordance with the laws of us.

readme.md

@@ -1,17 +1,17 @@
-# VSA Compression
-
-Uses Voronoi cells to compress and decompress an image
-
-## Usage
-
-```
-compression.py [-h] -i IN_IMAGE -o OUT_IMAGE
-
-arguments:
-  -h, --help            show this help message and exit
-  -i IN_IMAGE, --in-image IN_IMAGE
-                        the filepath to read an image from, this image will be
-                        compressed
-  -o OUT_IMAGE, --out-image OUT_IMAGE
-                        the filepath to write the compressed image to
-```
+# Voronoi Compression
+
+Uses Voronoi cells to compress and decompress an image.
+
+## Usage
+
+```
+compression.py [-h] -i IN_IMAGE -o OUT_IMAGE
+
+arguments:
+  -h, --help            show this help message and exit
+  -i IN_IMAGE, --in-image IN_IMAGE
+                        the filepath to read an image from, this image will be
+                        compressed
+  -o OUT_IMAGE, --out-image OUT_IMAGE
+                        the filepath to write the compressed image to
+```

setup.py

@@ -4,8 +4,8 @@
     requirements = requirements_file.read().splitlines()
 
 setup(
-    name='vsa-compression',
-    version='0.2',
+    name='voronoi-compression',
+    version='1.0',
     author='Shayaan Syed Ali',
     author_email='shayaan.syed.ali@gmail.com',
     install_requires=requirements,