Skip to content

Commit b3e5e15

Browse files
committed
Updated README with ACCESS_TOKEN and RC file instructions
1 parent 38b2c98 commit b3e5e15

1 file changed

Lines changed: 28 additions & 5 deletions

File tree

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,20 +29,43 @@ Or install RubyGems version, which will receive more attention to stability:
2929

3030
* All methods are tested with Rspec and WebMock. Most methods do not have integration tests that reach out to the live Buffer API servers. Proceed with caution until Buff reaches v0.1.0 and submit issues on Github Issues tab.
3131
* Authentication is not included in this gem (Try OAuth-buffer2) or use the single API key given when registering your own Buffer Dev credentials.
32+
* Commandline bin is provided to enable posting of updates:
33+
`buff Super witty stuff that fits in 140 chars`
34+
Will post to your first account when setup following instructions below.
35+
_A more convenient setup is planned in future releases._
3236
* For convenience load credentials into `~/.bufferapprc` in the following layout. This allows the `ACCESS_TOKEN` to be loaded into `Buff::ACCESS_TOKEN`:
3337

3438

3539
```
36-
CLIENT_ID
37-
CLIENT_SECRET
3840
ACCESS_TOKEN
41+
PROFILE_INDEX (default of 0)
3942
4043
# Structure:
41-
# client ID line 1
42-
# client secret line 2
43-
# Access Token: line 3
44+
# Access Token: line 1
45+
# Profile number, counting from zero
4446
```
4547

48+
## Access Token Instructions
49+
50+
How to Get Started:
51+
====
52+
* Create a Developer API Token here: http://bufferapp.com/developers/apps/create.
53+
* Fill in Stuff. Your answers don't matter much for the purpose of this rudimentary setup.
54+
* Submit that form and wait a short period (~2 min )
55+
* Visit: http://bufferapp.com/developers/apps
56+
* Gather Access Token and place it on line 1 of this file.
57+
* Copy this file to the root of your user's home folder:
58+
- ~/.bufferapprc
59+
* Set Line 2 to 0 if you only have one account to post to. Otherwise it's more complicated ;). Find me on Twitter and I can explain [@_ZPH](https://twitter.com/_ZPH).
60+
61+
Structure:
62+
Line 1: Access Token
63+
Line 2: Buffer Account number, ie posting to first account in list, use 0 (ie zero)
64+
65+
TODO: convert to yaml and improve instructions
66+
remove need for user to create their own App on bufferapp.com
67+
Future versions will integrate with Buffer-OAuth system.
68+
4669
## API Coverage
4770

4871
#### Implemented

0 commit comments

Comments
 (0)