README.md in tlapse-0.4.0 vs README.md in tlapse-0.4.1
- old
+ new
@@ -7,17 +7,26 @@
1. Install gphoto2
* macOS: `brew install gphoto2`
* Debian/Ubuntu: `sudo apt install gphoto2`
-2. `gem install tlapse` or add `gem 'tlapse'` to your `Gemfile`.
+2. `gem install tlapse`
+## Example: Integrate with cron
+
+* From 9 AM to sunset, capture one image every 10 minutes
+
+```
+0 9 * * * cd $HOME && eval "$(tlapse until_sunset --interval 10)" >> capture.log
+```
+
## CLI
Find better documentation by running `tlapse help` or `tlapse help SUBCOMMAND`
* `tlapse capture` - Capture an image using the tethered camera
+* `tlapse until_sunset` - Generate a gphoto2 command which captures images until sunset
## API
Mostly useful for cronjobs and the like.
@@ -25,16 +34,16 @@
```ruby
Tlapse::Capture.timelapse_command({
from: Time.now,
to: Time.now + 6.hours,
interval: 30.minutes
- }) # => "gphoto2 --capture-image-and-download -I 1800 -F 12 --filename \"%Y-%m-%d_%H-%M-%S.jpg\""
+ }) # => "gphoto2 --capture-image-and-download -I 1800 -F 12 --filename '%Y-%m-%d_%H-%M-%S.jpg'"
```
* Capture images from sunset to sunrise
```ruby
Tlapse::Capture.timelapse_command_while_sun_is_up(interval: 30.minutes)
- # => "gphoto2 --capture-image-and-download -I 1800 -F -9"
+ # => "gphoto2 --capture-image-and-download -I 1800 -F 11 --filename '%Y-%m-%d_%H-%M-%S.jpg'"
```
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).