Skip to content
This repository has been archived by the owner on Oct 23, 2023. It is now read-only.

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Dephilia <me@dephilia.moe>
  • Loading branch information
Dephilia committed Nov 22, 2022
1 parent 33394ea commit 99f680f
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "plurkcli"
version = "0.1.0"
version = "0.1.1"
authors = ["Dephilia <me@dephilia.moe>"]
edition = "2021"

Expand Down
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,30 @@ You'll need `key.toml` to configure Plurk oauth key.
Usage: plurk [OPTIONS]
Options:
-k, --key-file <KEY_FILE> [default: key.toml]
-k, --key-file <KEY_FILE>
[default: "$XDG_CONFIG_DIR/plurk-cli/key.toml"]
-g, --gen-key
--consumer-key <CONSUMER_KEY>
--consumer-secret <CONSUMER_SECRET>
--token-key <TOKEN_KEY>
--token-secret <TOKEN_SECRET>
-c, --comet
-m, --me
-t, --timeline
-v, --verbose
-h, --help Print help information
-V, --version Print version information
-h, --help
Print help information
-V, --version
Print version information
```

The example for `key.toml` is:
Expand All @@ -39,6 +56,8 @@ secret = ""

The oauth_token field is neglectable, while the cli will help you to update it.

You can also use `--gen-key` option to generate the key file.

## TODO
- A rust plurk library
- More flag, function for cli
Expand Down

0 comments on commit 99f680f

Please sign in to comment.