Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 75 lines (41 sloc) 2.864 kB
72947ef @mwunsch Setup.
authored
1 # tumblr
2
7408af9 @mwunsch Edit README for v2
authored
3 Command line interface and Ruby client for the [Tumblr API](http://www.tumblr.com/docs/en/api/v2)
72947ef @mwunsch Setup.
authored
4
e8a9502 @mwunsch README update
authored
5 It's been rewritten from the ground up to support v2 of the api.
7408af9 @mwunsch Edit README for v2
authored
6
e8a9502 @mwunsch README update
authored
7 Like the v1, the current version reads files with a special front-matter block, like [Jekyll](http://tom.preston-werner.com/jekyll/). In addition, this new version offers the ability to post photos, videos, and audio.
7408af9 @mwunsch Edit README for v2
authored
8
9 Unlike the previous version, this new command line utility uses OAuth to authenticate and authorize the user.
10
e8a9502 @mwunsch README update
authored
11 ## Installation
7408af9 @mwunsch Edit README for v2
authored
12
e8a9502 @mwunsch README update
authored
13 If you're on a Mac using [Homebrew](http://mxcl.github.com/homebrew/) and are just interested in the cli:
9dad3af @mwunsch Adding info for docs, metrics, gems.
authored
14
e8a9502 @mwunsch README update
authored
15 brew install https://raw.github.com/mwunsch/tumblr/master/share/tumblr-rb.rb
531d87d @mwunsch gem is called tumblr-rb is already taken
authored
16
e8a9502 @mwunsch README update
authored
17 Or with gem:
18
19 gem install tumblr-rb
7408af9 @mwunsch Edit README for v2
authored
20
faff72f @mwunsch Add gem building instructions to README
authored
21 Alternatively, you can clone the repo, and run `rake install` -- this will build the gem, place it in the `pkg` directory, and install the gem to your system. You should then be able to `require 'tumblr'` and/or run `tumblr` from the command line.
22
7408af9 @mwunsch Edit README for v2
authored
23 ## Authorization
24
25 Run `tumblr authorize` to boot up a small application to manage the fancy OAuth handshake with tumblr. You'll be prompted for a consumer key and secret you get from [registering an app](http://www.tumblr.com/oauth/apps).
ac924d7 @mwunsch Adding info about CLI
authored
26
4924098 @mwunsch Updating README
authored
27 ## Getting Started
28
29 Like [Jekyll](http://tom.preston-werner.com/jekyll/), and [Mustache](http://defunkt.github.com/mustache/), Tumblr gem will transform documents preceded by a [YAML](http://www.yaml.org/) frontmatter block.
30
31 YAML frontmatter beings with `---` on a single line, followed by YAML, ending with another `---` on a single line, e.g.
32
33 ---
34 type: quote
35 source: Billy Shakespeare
36 state: draft
37 tags: hamlet, shakespeare
38 ---
39 "To be or not to be."
40
7408af9 @mwunsch Edit README for v2
authored
41 Understood YAML parameters are taken from the Tumblr API: http://www.tumblr.com/docs/en/api/v2#posting
ac924d7 @mwunsch Adding info about CLI
authored
42
7408af9 @mwunsch Edit README for v2
authored
43 ### All Posts
4924098 @mwunsch Updating README
authored
44
7408af9 @mwunsch Edit README for v2
authored
45 type text, photo, link, quote, chat, video, audio
4924098 @mwunsch Updating README
authored
46 will take a guess if ommitted.
7408af9 @mwunsch Edit README for v2
authored
47
48 state published, queue, draft, private
49
4924098 @mwunsch Updating README
authored
50 format html or markdown
7408af9 @mwunsch Edit README for v2
authored
51
4924098 @mwunsch Updating README
authored
52 tags comma-separated list of tags
7408af9 @mwunsch Edit README for v2
authored
53
4924098 @mwunsch Updating README
authored
54 date post date
7408af9 @mwunsch Edit README for v2
authored
55
4924098 @mwunsch Updating README
authored
56 slug A custom string to appear in the post's URL
7408af9 @mwunsch Edit README for v2
authored
57
58 tweet Manages the autotweet (if enabled) for this post
531d87d @mwunsch gem is called tumblr-rb is already taken
authored
59
e8a9502 @mwunsch README update
authored
60 See [tumblr(5)](http://mwunsch.github.com/tumblr/tumblr.5.html) for more info.
61
5bcf752 @imkmf Better documentation for $HOST environment variable
imkmf authored
62 ## Configuration
63
2241ab5 @imkmf TUMBLRHOST, not HOST
imkmf authored
64 The gem has some configuration options – API keys are kept in `~/.tumblr` and can be changed if needed. It will also use a `$TUMBLRHOST` environment variable if specified. These are usually placed in your `.bashrc` or `.zshrc`, or specified on running the `tumblr` command: `TUMBLRHOST=foo.tumblr.com tumblr post "Hello world!"`
5bcf752 @imkmf Better documentation for $HOST environment variable
imkmf authored
65
149f92e @mwunsch New TODO
authored
66 ## TODO
67
856a50c @mwunsch Update man page w/ new list command.
authored
68 - [ ] Photoset support
149f92e @mwunsch New TODO
authored
69
72947ef @mwunsch Setup.
authored
70 ## Copyright
71
856a50c @mwunsch Update man page w/ new list command.
authored
72 The Tumblr gem is Copyright (c) 2010 - 2013 Mark Wunsch and is licensed under the [MIT License](http://creativecommons.org/licenses/MIT/).
72947ef @mwunsch Setup.
authored
73
d1c5a0f @mwunsch Posts can like/unlike themselves
authored
74 Tumblr is Copyright (c) Tumblr, Inc. The Tumblr gem is NOT affiliated with Tumblr, Inc.
Something went wrong with that request. Please try again.