Update readme and examples

Author: n0spaces

README.md

@@ -2,49 +2,81 @@
 A Python module and command-line tool that generates a 
 [Get Stick Bugged Lol](https://knowyourmeme.com/memes/get-stick-bugged-lol) video from any image.
 
-![Example](examples/python.gif)
+## Example
+```commandline
+gsbl python.jpg python.mp4 -r 760 475 -s 0.7
+```
+![Example GIF](examples/python.gif)
 
-[Example video with sound](https://github.com/n0spaces/get-stick-bugged-lol/raw/master/examples/python.mp4)
+[Example video with sound](examples/python.mp4)
 
 This script uses [pylsd-nova](https://github.com/AndranikSargsyan/pylsd-nova) to detect line segments in the image,
 Pillow to draw the lines as they move to form the stick bug, and MoviePy to create the video.
 
+## Requirements
+* Python 3.6 or later (any OS)
+
 ## Installation
 This package can be installed using pip:
-```
+```commandline
 pip install get-stick-bugged-lol
 ```
 
 ## Usage
-#### In the terminal
+### In the terminal
 Installing the package will register the `gsbl` command in the terminal (or you can use `python -m gsbl`). To use the
 image `input.png` to generate the video `output.mp4`:
-```
+```commandline
 gsbl input.png output.mp4
 ```
 Optional arguments:
-* `-h, --help` Display the help message and exit
-* `--line-color R G B` RGB color to use for line segments (default: 255 255 211)
-* `--bg-color R G B` RGB color to use for background after image disappears (default: 125 115 119)
-
-More options will be added in later releases.
+* `-h, --help` show this help message and exit
+* `-r --resolution WIDTH HEIGHT` width and height of the video (default: 720 720)
+* `--img-bg-color R G B` RGB background color while the image is visible (default: 0 0 0)
+* `--line-color R G B` RGB color of line segments (default: 255 255 211)
+* `--line-bg-color R G B` RGB background color after image disappears (default: 125 115 119)
+* `-s --scale SCALE` the image scale passed to the line segment detector. Slightly lowering this may improve results in
+large images. This does not affect the image scale in the video (try --resolution instead). (default: 0.8)
 
-#### In a Python script
+### In a Python script
 
 ```python
-import gsbl
+from PIL import Image
+from gsbl.stick_bug import StickBug
 
-# generate the video from input.png
-video = gsbl.generate_stick_bug('input.png')
+# Create the StickBug object
+sb = StickBug(Image.open('example.png'))  # parameter can also just be a filepath
 
-# save the video as output.mp4
-gsbl.save_video(video, 'output.mp4')
+# Change some properties if you want
+sb.video_resolution = (1280, 720)
+sb.lsd_scale = 0.5
+
+# That's it! The video will be generated the first time you access it
+video = sb.video  # MoviePy VideoClip
+
+# Or you can just save it
+sb.save_video('example.mp4')
+
+# If any settings were changed, the video will be regenerated the next time you access it.
+sb.line_color = (128, 0, 255)
+video_purple = sb.video
 ```
 
-## TODO
-* Rewrite to be more object-oriented and easier to maintain
-* Add more customization options, especially with the line detection and video resolution
-* Make a GUI
+#### `StickBug` properties
+* `image` the source PIL Image. You can set this when initializing `StickBug`, or at any time by accessing the property.
+If you want, you can leave this parameter empty while initializing.
+* `segments` a numpy array of the 9 line segments detected. If the line segment detector hasn't run yet, that's done the
+first time this is accessed. The line segment detector will run again if any other properties have changed. This can
+also be set manually if you want. Each row of the array must contain the values `[x1, y1, x2, y2, width]`.
+* `video` (readonly) the MoviePy VideoClip generated by the script. If the video hasn't been generated yet, that's
+done the first time this is accessed. The video will be regenerated if any other properties have changed.
+
+* `video_resolution` the resolution of the video as a tuple
+* `lsd_scale` the image scale passed to the line segment detector. Slightly lowering this may improve results in large
+images. This does not affect the image scale in the video.
+* `img_bg_color` the background color of the video while the image is visible
+* `line_color` the color of the line segments in the video
+* `line_bg_color` the background color of the video after the image disappears
 
 ## License
 This package is available under the MIT License. See [LICENSE](LICENSE) for more info.

examples/python.gif

@@ -17,18 +17,13 @@ def main():
                         metavar=('R', 'G', 'B'),
                         help='RGB background color after image disappears (default: 125 115 119)')
     parser.add_argument('-s --scale', dest='lsd_scale', type=float, default=0.8, metavar='SCALE',
-                        help='the image scale passed to the line segment detector. Slightly lowering this may improve'
+                        help='the image scale passed to the line segment detector. Slightly lowering this may improve '
                              'results in large images. This does not affect the image scale in the video (try '
                              '--resolution instead). (default: 0.8)')
 
     args = parser.parse_args()
 
-    try:
-        from gsbl.stick_bug import StickBug
-    except ImportError:
-        # if running this file directly while the package isn't installed
-        # noinspection PyUnresolvedReferences
-        from stick_bug import StickBug
+    from gsbl.stick_bug import StickBug
 
     sb = StickBug(img=args.input, video_resolution=args.resolution, lsd_scale=args.lsd_scale,
                   img_bg_color=args.img_bg_color, line_color=args.line_color, line_bg_color=args.line_bg_color)