Skip to content

Commit 5c73d0f

Browse files
committed
README is updated
1 parent f97a7c5 commit 5c73d0f

File tree

1 file changed

+33
-12
lines changed

1 file changed

+33
-12
lines changed

README.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,51 @@
11
gist-put
22
=======
33

4-
`gist-put` is a [gist](https://gist.github.com/) command line utility. It
5-
makes files into gists!
4+
`gist-put` is a [gist](https://gist.github.com/) command line utility. It makes gists out of files!
65

76
## features ##
87

9-
- `gist-put` takes multiple files or single files, or
8+
- it takes multiple files, single files, or
109
[eventually](https://github.com/AWinterman/gist-put/blob/master/gist-put#L17-L20),
1110
no files at all!
12-
- `gist-put` doesn't care if you reference files in some or in some distant
13-
directory,
14-
- `git-put` gets your credentials at your already-stated level of security
11+
- it doesn't care if you reference files in `pwd` or in some distant
12+
directory, (this was a problem with the alternative I tried).
13+
- it gets your credentials at your already-stated level of security
1514
using the `git credential` tool. If `git credentials` doesn't know your
1615
credentials, it'll probably error in an ugly way. [This is an open
1716
issue](https://github.com/AWinterman/gist-put/issues/1).
1817

19-
It then gets an OAuth2 token from github (or finds the one it already
20-
registered to your account). Your git credentials are safe the entire time, or no less safe than
21-
they were given that `git credential fill` will print your password in plain
22-
text.
18+
It'll get your OAuth2 token from github, letting them deal with how to store
19+
such things securely. Your git credentials are safe the entire time, or no
20+
less safe than they were given that `git credential fill` will print your
21+
password in plain text if you ask nicely.
2322

2423
This module distinguishes itself from the others on npm in that it never asks
2524
you to store your github credentials anywhere in plain text, doesn't ask you to
26-
edit any files in order to store your api token, and is a piece of general node
27-
badassery. Enjoy!
25+
edit any files in order to store your api token, and has a better sense of
26+
humor. Enjoy!
27+
28+
## installation ##
29+
30+
You'll love it, so why don't you npm install it:
31+
```
32+
$ npm install git-put
33+
```
34+
35+
36+
If you ever decide you hate it, npm uninstall ftw!
37+
38+
```
39+
npm uninstall git-put
40+
```
41+
42+
And then find `git-put` among your [authorized apps](https://github.com/settings/applications) on github, and remove it from
43+
the list.
44+
45+
I guess I could provide a commandline argument for this last step... If this is
46+
something you'd like, contact me @AWinterman (on github) or @AndyWinterman (on
47+
twitter) and we can work it out. Even better, submit a pull request!
48+
2849

2950
## usage ##
3051

0 commit comments

Comments
 (0)