README.md in pinpress-1.1.1 vs README.md in pinpress-1.1.2
- old
+ new
@@ -1,8 +1,7 @@
PinPress
========
-[](https://travis-ci.org/bachya/PinPress)
[](http://badge.fury.io/rb/pinpress)
PinPress is a simple CLI to create templates (HTML, Markdown, or otherwise) of Pinboard pins and tags.
# Why?
@@ -26,18 +25,18 @@
Syntax and usage can be accessed by running `pinpress help`:
```
$ pinpress help
NAME
- pinpress - A Pinboard application that allows for the creation of
+ pinpress - A Pinboard application that allows for the creation of
"pin templates" in almost any conceivable format.
SYNOPSIS
pinpress [global options] command [command options] [arguments...]
VERSION
- 1.1.1
+ 1.1.2
GLOBAL OPTIONS
--help - Show this message
--version - Display the program version
@@ -74,11 +73,11 @@
Initialization will prompt you to enter your Pinboard API token. Once, entered, this (and other pertinent data) will be stored in `~/.pinpress`.
# Templates
-The first stop on the PinPress journey is templates. Templates are used to define how data should be output and are defined in `~/.pinpress`. They come in two forms: **Pin Templates** and **Tag Templates**.
+The first stop on the PinPress journey is templates. Templates are used to define how data should be output and are defined in `~/.pinpress`. They come in two forms: **Pin Templates** and **Tag Templates**.
## Pin Templates
Pin Templates define how a pin from Pinboard should be output.
@@ -221,11 +220,11 @@
Pinpress also provides some flags that allow a user to define specific pins to grab:
* `-s`: the start date to use (uses [Chronic](https://github.com/mojombo/chronic "Chronic"), which allows dates like "last Tuesday")
* `-e`: the end date to use (also uses [Chronic](https://github.com/mojombo/chronic "Chronic"))
* `-n`: the number of pins to return (e.g., 20)
-* `-t`: a CSV list of tags to grab (e.g., "tag1,tag2")
+* `-t`: a CSV list of tags (e.g., "tag1,tag2") that must exist for the returned pins
Naturally, these switches can be combined in any number of ways.
## Getting Pins From a Date Forward
@@ -270,10 +269,11 @@
Pinpress also provides some flags that allow a user to define specific tags to grab:
* `-s`: the start date to use (uses [Chronic](https://github.com/mojombo/chronic "Chronic"), which allows dates like "last Tuesday")
* `-e`: the end date to use (also uses [Chronic](https://github.com/mojombo/chronic "Chronic"))
+* `-t`: a CSV list of tags (e.g., "tag1,tag2") to examine for association (see [below](#getting-tags-that-have-been-used-with-other-tags)).
## Getting Tags From a Date Forward
```
$ pinpress tags -s 2014-01-01
@@ -293,15 +293,23 @@
```
$ pinpress tags -s 2014-01-01 -e 2014-01-31
```
+## Getting Tags that Have Been Used With Other Tags
+
+```
+$ pinpress tags -t 'tag1,tag2' -s 2014-01-01
+```
+
+...returns all tags that have been used *alongside* `tag1` and `tag2`, starting on Jarnuary 1, 2014.
+
# Other Configuration Options
In addition to `default_pin_template` and `default_tag_template`, you can place some other special keys in the `pinpress` section of `~/.pinpress`:
-* `default_tags`: the default tags to be used when getting pins (e.g., `'ruby,pinboard'`). This can be overridden by using the `-t` flag.
+* `default_tags`: the default tags (e.g., `'ruby,pinboard'`) to be used when getting pins or associated tags. This can be overridden by using the `-t` flag.
* `default_num_results`: the default number of results to return (e.g., '5'). This can be overridden by using the `-n` flag.
# Known Issues & Future Releases
Check out the Pinpress roadmap via the [Trello Board](https://trello.com/b/lmuC8TT0/pinpress "Pinpress Trello Board").
@@ -328,6 +336,6 @@
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
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.
\ No newline at end of file
+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.