README.md in sifttter-redux-1.0.4 vs README.md in sifttter-redux-1.0.5
- old
+ new
@@ -3,28 +3,12 @@
[](https://travis-ci.org/bachya/Sifttter-Redux)
[](http://badge.fury.io/rb/sifttter-redux)
# Upgrading From 0.x.x to 1.0.0?
-Version 1.0.0 uses a new schema that allows for any type of Markdown. Using
-version 1.0.0, Sifttter files need to follow this format:
+Make sure you read the [IFTTT Template](#ifttt-template) section.
-```
-@begin
-@date April 21, 2014
-**Any** sort of *Markdown* goes here...
-@end
-```
-
-Note that a new command has been introduced that attempts to upgrade to this
-new format. **Although the command backs up your current Sifttter files, you
-are strongly encouraged to make a separate, manual backup.**
-
-```Bash
-$ srd upgrade
-```
-
# Intro
Siftter Redux is a modification of Craig Eley's
[Sifttter](http://craigeley.com/post/72565974459/sifttter-an-ifttt-to-day-one-logger "Sifttter"),
a script to collect information from [IFTTT](http://www.ifttt.com "IFTTT") and
@@ -63,11 +47,11 @@
SYNOPSIS
srd [global options] command [command options] [arguments...]
VERSION
- 1.0.4
+ 1.0.5
GLOBAL OPTIONS
--help - Show this message
--[no-]verbose - Turns on verbose output
--version - Display the program version
@@ -98,10 +82,50 @@
--[no-]verbose - Turns on verbose output
-w arg - Run catch-up mode for the last N weeks (default: none)
-y - Run catch-up mode for yesterday
```
+## IFTTT Template
+
+Version 1.0.0+ uses a new schema that allows for any type of Markdown. Thus, Sifttter
+files from IFTTT need to follow this format:
+
+```
+@begin
+@date April 21, 2014 at 12:34PM
+**Any** sort of *Markdown* goes here...
+@end
+```
+
+Whereas the previous Sifttter Redux only allowed output of bulleted lists, this new
+template style allows you to include *any* Markdown, making output like tables possibe.
+
+### Upgrade Command
+
+Note that a new command has been introduced that attempts to upgrade to this
+new format. **Although the command backs up your current Sifttter files, you
+are strongly encouraged to make a separate, manual backup.**
+
+```Bash
+$ srd upgrade
+```
+
+### Template Tokens
+
+IFTTT templates can make use of the following tokens:
+
+* `%time%`: the time the entry was created
+
+As an example, to include the entry time in a template:
+
+```
+@begin
+@date April 21, 2014 at 12:34PM
+- %time%: My text goes here...
+@end
+```
+
## Initialization
```
$ srd init
```
@@ -165,9 +189,25 @@
To create an entry for yesterday:
```
$ srd exec -y
+#### EXECUTING...
+---> INFO: Creating entry for February 14, 2014...
+---> INFO: Downloading Sifttter files...DONE.
+---> SUCCESS: Entry logged for February 14, 2014...
+---> INFO: Uploading Day One entries to Dropbox...DONE.
+---> INFO: Removing downloaded Day One files...DONE.
+---> INFO: Removing downloaded Sifttter files...DONE.
+#### EXECUTION COMPLETE!
+```
+
+### Catch-up for a Specific Date
+
+To create an entry for specific date:
+
+```
+$ srd exec -d 2014-02-14
#### EXECUTING...
---> INFO: Creating entry for February 14, 2014...
---> INFO: Downloading Sifttter files...DONE.
---> SUCCESS: Entry logged for February 14, 2014...
---> INFO: Uploading Day One entries to Dropbox...DONE.