Document how to configure OAuth.
[gregoa/bti.git] / README
1 bti - bash twitter/identi.ca ididocy
2
3 Allows you to pipe your bash input to twitter or identi.ca in an easy
4 and fast manner to annoy the whole world.
5
6 See the man page bti.1 for how to use it and more information.
7
8 Be careful if you use this, it is quite easy to end up sending sensitive
9 data to the world with it.
10
11 USE AT YOUR OWN RISK!
12
13 Any questions, contact Greg Kroah-Hartman <greg@kroah.com> or @gregkh
14 on twitter or identi.ca.
15
16 bti is developed using git and the tree can be found at:
17         git://github.com/gregkh/bti.git
18 and browsed at:
19         http://github.com/gregkh/bti/
20
21
22 About OAuth configuration
23
24 If you want to use an OAuth-enabled service (like twitter), you should configure bti to use the
25 consumer key and secret shipped with the source code (check the oath.keys file).
26
27 For example, you should add the following two lines to your ~/.bti configuration
28 file:
29
30 ---8<-------------------
31 # Consumer key
32 consumer_key=cZy8DdioswAfu3LJYg6E2w
33
34 # Consumer secret
35 consumer_secret=fnIGGU0T12mMWKjmThUdSeKN32NLWfmnwapwubVQ
36 ---8<-------------------
37
38 The next time that you run bti, you will be told to visit an URL that will
39 provide you a PIN number. You should then input that number in the bti prompt,
40 and you will be given two new configuration values
41 (access_token_secret and access_token_key) that you need to add to your
42 bti configuration file to authenticate requests from bti.