README.md in sifttter-redux-0.3.3 vs README.md in sifttter-redux-0.3.4

- old
+ new

@@ -5,11 +5,11 @@ Siftter Redux's primary difference is in its execution method: it intended to run autonomously so that it does not need to be manually activated. This allows IFTTT data to be synchronized to Day One on a schedule. The aim of this project was to use a Raspberry Pi; as such, the instructions below are specifically catered to that platform. That said, it should be possible to install and configure on any *NIX platform. -## Prerequisites +# Prerequisites In addition to Git (which, given you being on this site, I'll assume you have), there are two prerequisites needed to run Sifttter Redux in a *NIX environment: * Ruby (version 1.9.3 or greater) * UUID (required on the Raspberry Pi because it doesn't come with a function to do this by default) @@ -19,17 +19,17 @@ ``` $ sudo apt-get install ruby $ sudo apt-get install uuid ``` -## Installation +# Installation ``` gem install sifttter-redux ``` -## Usage +# Usage Syntax and usage can be accessed by running `srd help`: ``` $ srd help @@ -53,11 +53,11 @@ exec - Execute the script help - Shows a list of commands or help for one command init - Install and initialize dependencies ``` -### Initialization +## Initialization ``` $ srd init ``` @@ -68,11 +68,11 @@ 1. The location on your filesystem where Sifttter files will be temporarily stored 2. The location of your Sifttter files in Dropbox 3. The location on your filesystem where Day One files will be temporarily stored 4. The location of your Day One files in Dropbox -### Basic Execution +## Basic Execution ``` $ srd exec #### EXECUTING... ---> INFO: Creating entry for February 15, 2014... @@ -82,17 +82,17 @@ ---> INFO: Removing downloaded Day One files...DONE. ---> INFO: Removing downloaded Sifttter files...DONE. #### EXECUTION COMPLETE! ``` -### "Catch-up" Mode +## "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 on or before today's date. There are many ways to use this mode (note that "today" in these examples is **February 15, 2014**): -#### Yesterday Catch-up +### Yesterday Catch-up To create an entry for yesterday: ``` $ srd exec -y @@ -104,11 +104,11 @@ ---> INFO: Removing downloaded Day One files...DONE. ---> INFO: Removing downloaded Sifttter files...DONE. #### EXECUTION COMPLETE! ``` -#### Last "N" Days Catch-up +### Last "N" Days Catch-up Sifttter Redux allows you to specify the number of days back it should look for new entries: ``` $ srd exec -n 3 @@ -122,10 +122,11 @@ ---> INFO: Removing downloaded Day One files...DONE. ---> INFO: Removing downloaded Sifttter files...DONE. #### EXECUTION COMPLETE! $ srd exec -n 12 +#### EXECUTING... ---> INFO: Creating entries for dates from February 03, 2014 to February 14, 2014... ---> INFO: Downloading Sifttter files...DONE. ---> SUCCESS: February 03, 2014... ---> SUCCESS: February 04, 2014... ---> SUCCESS: February 05, 2014... @@ -159,11 +160,11 @@ ---> INFO: Removing downloaded Day One files...DONE. ---> INFO: Removing downloaded Sifttter files...DONE. #### EXECUTION COMPLETE! ``` -#### Last "N" Weeks Catch-up +### Last "N" Weeks Catch-up Sifttter Redux also allows you to specify a number of weeks back that should be scanned for new entries: ``` $ srd exec -w 1 @@ -247,11 +248,11 @@ ---> INFO: Removing downloaded Day One files...DONE. ---> INFO: Removing downloaded Sifttter files...DONE. #### EXECUTION COMPLETE! ``` -#### Date Range Catch-up +### Date Range Catch-up To create entries for a range of dates: ``` $ srd exec -f 2014-02-01 -t 2014-02-12 @@ -352,46 +353,46 @@ #### EXECUTION COMPLETE! ``` See [Chronic's Examples section](https://github.com/mojombo/chronic#examples "Chronic Examples") for more examples. -## Cron Job +# Cron Job By installing an entry to the Raspberry Pi's `crontab`, Sifttter Redux can be run automatically on a schedule. One issue that arises is the loading of the bundled gems; because `cron` runs in a limited environment, it does not automatically know where to find installed gems. -### Using RVM +## Using RVM If your Raspberry Pi uses RVM, this `crontab` entry will do: ``` 55 23 * * * /bin/bash -l -c 'source "$HOME/.rvm/scripts/rvm" && srd exec' ``` -### Globally Installing Bundled Gems +## Globally Installing Bundled Gems Another option is to install the bundled gems to the global gemset: ``` $ bundle install --global ``` -## Known Issues +# Known Issues * Sifttter Redux makes no effort to see if entries already exist in Day One for a particular date. This means that if you're not careful, you might end up with duplicate entries. A future version will address this. * At indeterminiate times (usually when in catch-up mode), Sifttter Redux will upload a file to Day One that Day One fails to read. Uncertain of the cause at this stage, but it's happened a few times. -## Future Releases +# Future Releases Some functionality I would like to tackle for future releases: * Plugin architecture for services that IFTTT doesn't support * Interactive cron job installer * Smarter checking of the config file to see if an old version is being used -## Bugs and Feature Requests +# 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). Contributions are welcome and encouraged. To contribute: @@ -399,11 +400,11 @@ * Create a branch for your contribution (`git checkout -b new-feature`). * Commit your changes (`git commit -am 'Added this new feature'`). * Push to the branch (`git push origin new-feature`). * Create a new [Pull Request](http://github.com/bachya/sifttter-redux/compare/). -## License +# License (The MIT License) Copyright © 2014 Aaron Bach <bachya1208@gmail.com> @@ -411,10 +412,10 @@ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 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 +# Credits * 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