README.md in sifttter-redux-0.2.0 vs README.md in sifttter-redux-0.2.1

- old
+ new

@@ -23,60 +23,46 @@ $ sudo apt-get install uuid ``` ## Installation -First, clone this repository via git: - ``` -$ git clone https://github.com/bachya/Sifttter-Redux.git +gem install sifttter-redux ``` -Next, cd into the Sifttter Redux directory and install the necessary gems: - -``` -$ cd Sifttter-Redux -$ bundle install -``` - -*(note that you may want to run `bundle install --global` for the sake of `cron` -- [see below](#cron-job))* - -Finally, make sure the script is executable and initialize it: - -``` -$ chmod +x srd -$ ./srd init -``` - ## Usage -Syntax and usage can be accessed by running `./srd help`: +Syntax and usage can be accessed by running `srd help`: ``` -$ ./srd help +$ srd help NAME - srd - Sifttter Redux v1.1 + srd - Sifttter Redux A modification of Craig Eley's Sifttter that allows for smart installation on a standalone *NIX device (such as a Raspberry Pi). SYNOPSIS srd [global options] command [command options] [arguments...] +VERSION + 0.2.1 + GLOBAL OPTIONS - --help - Show this message + --help - Show this message + --version - Display the program version COMMANDS exec - Execute the script help - Shows a list of commands or help for one command init - Install and initialize dependencies ``` ### Initialization ``` -$ ./srd init +$ srd init ``` Initialization will perform the following steps: 1. Download [Dropbox-Uploader](https://github.com/andreafabrizi/Dropbox-Uploader "Dropbox-Uploder") to a location of your choice. @@ -88,11 +74,11 @@ ### Basic Mode ``` # Creates an entry for today -$ ./srd exec +$ srd exec ``` ### "Catch-up" Mode Sometimes, events occur that prevent Sifttter Redux from running (power loss to your device, a bad Cron job, etc.). In this case, Sifttter Redux's "catch-up" mode can be used to collect any valid journal data before the current day. @@ -103,50 +89,50 @@ To create entries for the past 7 days (not inclusive of the current day): ``` # Creates an entry for each day from from 7 days ago to yesterday -$ ./srd exec -c +$ srd exec -c ``` To include the current day: ``` # Creates an entry for each day from 7 days ago to today -$ ./srd exec -c -i +$ srd exec -c -i ``` #### Yesterday Catch-up To create an entry for yesterday: ``` # Creates an entry for yesterday -$ ./srd exec -y +$ srd exec -y ``` #### Date Range Catch-up To create entries for a range of dates: ``` # Creates an entry for each day from 2/1/2014 to 2/12/2014 -$ ./srd exec -f 2014-02-01 -t 2014-02-12 +$ srd exec -f 2014-02-01 -t 2014-02-12 ``` Even more simply, to create entries from a specific point until yesterday ("yesterday" because you might not be ready to have today's entries scanned): ``` # Creates an entry for each day from 2/1/2014 to yesterday's date -$ ./srd exec -f 2014-02-01 +$ srd exec -f 2014-02-01 ``` Of course, if you want to include today's date, you can always use the trusty `-i` switch: ``` # Creates an entry for each day from 2/1/2014 to today's date -$ ./srd exec -f 2014-02-01 -i +$ srd exec -f 2014-02-01 -i ``` Two notes to be aware of: * `-f` and `-t` are *inclusive* parameters, meaning that when specified, those dates will be included when searching for Siftter data. @@ -154,11 +140,11 @@ Sifttter Redux makes use of the excellent [Chronic gem](https://github.com/mojombo/chronic "Chronic"), which provides natural language parsing for dates and times. This means that you can run commands with more "human" dates: ``` # Natural language parsing is great! Thanks, Chronic! -$ ./srd exec -f "last Thursday" -t "yesterday" +$ srd exec -f "last Thursday" -t "yesterday" ``` See [Chronic's Examples section](https://github.com/mojombo/chronic#examples "Chronic Examples") for more examples. ## Cron Job @@ -170,11 +156,11 @@ ### Using RVM If your Raspberry Pi uses RVM, this `crontab` entry will do: ``` -55 23 * * * /bin/bash -l -c 'source "$HOME/.rvm/scripts/rvm" && "$HOME/Sifttter-Redux/srd" exec' +55 23 * * * /bin/bash -l -c 'source "$HOME/.rvm/scripts/rvm" && srd exec' ``` ### Globally Installing Bundled Gems Another option is to install the bundled gems to the global gemset: @@ -192,11 +178,11 @@ Some functionality I would like to tackle for future releases: * Interactive cron job installer * Verbose mode that more explicity tells the user what's currently going on -* Automatic gem bundling +* Smarter checking of the config file to see if an old version is being used ## Bugs and Feature Requests To report bugs with or suggest features/changes for Sifttter Redux, please use the [Issues Page](http://github.com/bachya/Sifttter-Redux/issues). @@ -220,8 +206,9 @@ THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ## Credits -* Craig Eley for Sifttter and for giving me the idea for Sifttter Redux -* Andrea Fabrizi for her stellar Dropbox Uploader project -* The Chronic folks for making the aforementioned wonderful Chronic gem +* Craig Eley for [Sifttter](http://craigeley.com/post/72565974459/sifttter-an-ifttt-to-day-one-logger "Sifttter") and for giving me the idea for Sifttter Redux +* Dave Copeland for [GLI](https://github.com/davetron5000/gli "GLI") +* Andrea Fabrizi for [Dropbox Uploader](https://github.com/andreafabrizi/Dropbox-Uploader "Dropbox Uploader") +* Tom Preston-Werner and Lee Jarvis for [Chronic](https://github.com/mojombo/chronic "Chronic") \ No newline at end of file