Skip to content

Commit ddbe113

Browse files
committed
📝 Improve installation and usage docs
1 parent 8baacf1 commit ddbe113

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

‎README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,18 @@ If bundler is not being used to manage dependencies, install the gem by executin
1515

1616
$ gem install oauth-tty
1717

18+
NOTE: You might see a warning like:
19+
```
20+
oauth-tty's executable "oauth" conflicts with oauth
21+
Overwrite the executable? [yN] y
22+
```
23+
The `oauth` executable from this gem *is* the extracted and repackaged executable from the `oauth` gem, so you *should* overwrite it.
24+
1825
## Usage
1926

20-
For now, please see the tests.
27+
In a shell run `oauth` to start the console.
28+
29+
For now, please see the tests for other usage.
2130

2231
## Development
2332

0 commit comments

Comments
 (0)