README.md in pinpress-1.6.2 vs README.md in pinpress-1.6.3
- old
+ new
@@ -40,11 +40,11 @@
SYNOPSIS
pinpress [global options] command [command options] [arguments...]
VERSION
- 1.6.0
+ 1.6.3
GLOBAL OPTIONS
--help - Show this message
--version - Display the program version
@@ -234,20 +234,20 @@
Pin Templates are placed under the `pin_templates` section of the `~/.pinpress`
config file -- as an example:
```yaml
pin_templates:
- pinpress_default
+- pinpress_default:
opener: "<ul>\n"
item: >
<li>
<b><a title="<%= description %>" href="<%= href %>" target="_blank">
<%= description %></a>.</b>
<%= extended %>
</li>
closer: "</ul>"
- # ... other templates ...
+# ... other templates ...
```
A Pin Template can have several different sub-keys:
* `opener` (*optional*): the text that should exist above the pins
@@ -283,20 +283,20 @@
pinpress:
config_location: "/Users/abach/.pinpress"
default_pin_template: pinpress_default
# ... other keys ...
pin_templates:
- pinpress_default
+- pinpress_default:
opener: "<ul>\n"
item: >
<li>
<b><a title="<%= description %>" href="<%= href %>" target="_blank">
<%= description %></a>.</b>
<%= extended %>
</li>
closer: "</ul>"
- # ... other templates ...
+# ... other templates ...
```
So, knowing the above, both:
```bash
@@ -337,11 +337,11 @@
They, too, are defined in `~/.pinpress`:
```yaml
tag_templates:
- pinpress_default
+- pinpress_default:
item: "<%= tag %> (<%= count %>),"
```
A Tag Template makes use of the same sub-keys as Pin Template:
@@ -374,13 +374,12 @@
default_tag_template: pinpress_default
# ... other keys ...
pin_templates:
# ... other keys ...
tag_templates:
- pinpress_default
- item: "<%= tag %> (<%= count %>),"
- # ... other templates ...
+ # ... other keys ...
+# ... other templates ...
```
So, knowing the above, both:
```bash
@@ -532,22 +531,22 @@
Individual templates can carry some special keys, too:
```yaml
pin_templates:
- - template_name:
- # ...other keys...
+- template_name:
+ # ...other keys...
- # The default tags to be used when running `pinpress pins`
- default_tags: ['tag1', 'tag2']
+ # The default tags to be used when running `pinpress pins`
+ default_tags: ['tag1', 'tag2']
- # The tags to that are removed from the results when running `pinpress tags`
- ignored_tags: ['bad-tag', 'bad-tag2']
+ # The tags to that are removed from the results when running `pinpress tags`
+ ignored_tags: ['bad-tag', 'bad-tag2']
- # The default number of results to return
- default_num_results: 5
+ # The default number of results to return
+ default_num_results: 5
- # ...other keys...
+ # ...other keys...
```
Do note:
* The `default_tags` key is overridden by the `-t` flag.