Skip to content

Commit 598429b

Browse files
committed
Adds help section to Readme
1 parent 715211f commit 598429b

2 files changed

Lines changed: 14 additions & 6 deletions

File tree

Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
linear-cli (0.4.0)
4+
linear-cli (0.4.4)
55
base64 (~> 0.2)
66
dry-cli (~> 1.0)
77
dry-cli-completion (~> 1.0)

Readme.adoc

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,14 @@ A command line interface to https://linear.app.
99

1010
== Installation
1111

12-
=== From Source
12+
=== Gem (Most should use this)
13+
14+
[source,sh]
15+
----
16+
$ gem install linear-cli
17+
----
18+
19+
=== From Source (You are obviously a developer)
1320

1421
[source,sh]
1522
----
@@ -23,20 +30,21 @@ $ rake install
2330

2431
=== Configuration
2532

26-
You must set the LINEAR_API_KEY environment variable to your Linear API key. You can find your API key at https://linear.app/settings/api.
33+
You must set the LINEAR_API_KEY environment variable to your Linear API key.
34+
You can find your API key in your https://linear.app/settings/api[Linear Settings].
2735

2836
==== Tab Completion
2937

30-
If you are using bash or zsh, you can enable tab completion by adding the following to your .bashrc or .zshrc:
38+
If you are using bash or zsh, you can enable tab completion by adding the following to your `.bashrc` or `.zshrc`:
3139

32-
Bash:
40+
bash:
3341

3442
[source,sh]
3543
----
3644
eval "$(lc completion bash)"
3745
----
3846

39-
Zsh:
47+
zsh:
4048

4149
[source,sh]
4250
----

0 commit comments

Comments
 (0)