Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit d671ec8

Browse files
committed
Update README.
Signed-off-by: Eric Wang <skygragon@gmail.com>
1 parent 58660e9 commit d671ec8

File tree

1 file changed

+19
-46
lines changed

1 file changed

+19
-46
lines changed

README.md

Lines changed: 19 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
3rd party plugins for leetcode-cli.
66

7-
See what [leetcode-cli](https://github.com/skygragon/leetcode-cli) is.
7+
* what is [leetcode-cli](https://github.com/skygragon/leetcode-cli)
8+
* how to use [leetcode-cli plugins](https://skygragon.github.io/leetcode-cli/commands#plugin)
9+
* how to use [leetcode-cli configs](https://skygragon.github.io/leetcode-cli/advanced#configuration)
810

911
## Plugins
1012

@@ -19,53 +21,24 @@ See what [leetcode-cli](https://github.com/skygragon/leetcode-cli) is.
1921
|[lintcode](/docs/lintcode.md)|Fight questions from lintcode.com|`list` `show` `test` `submit` `user`|
2022
|[solution.discuss](/docs/solution.discuss.md)|Fetch top voted solution|`show`|
2123

22-
## HOWTO
24+
## Quick Start
2325

24-
### Install
26+
$ leetcode plugin -i <name> # install
27+
$ leetcode plugin -d <name> # disable
28+
$ leetcode plugin -e <name> # enable
29+
$ leetcode plugin -D <name> # delete
2530

26-
Install plugin from this GitHub repo:
31+
$ leetcode plugin -c <name> # show config
32+
$ leetcode config plugins:<name> # show config
33+
$ leetcode config plugins:<name>:<key> <value> # set config
34+
$ leetcode config -d plugins:<name> # delete config
2735

28-
$ leetcode plugin -i <name>
29-
30-
*Example*
36+
**Example**
3137

32-
$ leetcode plugin -i company
38+
$ leetcode plugin -i company # install compnay
39+
$ leetcode plugin -D compnay # delete company
3340

34-
**NOTE: Check [leetcode-cli's plugin guide](https://skygragon.github.io/leetcode-cli/commands#plugin) for more details.**
35-
36-
### Configuration
37-
38-
Some plugins could be configured with your customized options. Please read plugin's doc to see the details.
39-
40-
*Example*
41-
42-
Take `gitHub` plugin for example:
43-
44-
Set configs:
45-
46-
$ leetcode config plugins:github:token 12345678
47-
48-
Show configs:
49-
50-
$ leetcode config plugins:github
51-
$ leetcode plugin -c github
52-
53-
Delete configs:
54-
55-
$ leetcode config -d plugins:github
56-
57-
**NOTE: Check [leetcode-cli's configuration guide](https://skygragon.github.io/leetcode-cli/advanced#configuration) for more details.**
58-
59-
### Management
60-
61-
Disable:
62-
63-
$ leetcode plugin -d <name>
64-
65-
Enable:
66-
67-
$ leetcode plugin -e <name>
68-
69-
Delete:
70-
71-
$ leetcode plugin -D <name>
41+
$ leetcode plugin -c github # show github plugin config
42+
$ leetcode config plugins:github # show github plugin config
43+
$ leetcode config plugins:github:token 12345678 # set github plugin config
44+
$ leetcode config -d plugins:github # delete github plugin config

0 commit comments

Comments
 (0)