kup-cli 0.2.0 → 0.2.1

package/README.md

@@ -4,26 +4,28 @@ English | [中文](README.zh.md)
 
 <img src="https://user-images.githubusercontent.com/1231359/171321963-e8e73bdf-f9c8-435b-9707-318e92f1805a.png" width="150" height="80" align="right" alt="Kup logo">
 
-> A CLI tool to sync local Markdown files to GitHub issues.
+> A CLI tool to sync local Markdown files and GitHub issues bidirectionally.
 >
-> 这款命令行工具可以把本地的 Markdown 文件同步到 GitHub issue。
+> 一款命令行工具，实现本地 Markdown 文件与 GitHub Issues 的双向同步。
+
+
 
 ## Who Is It For
 
-* Bloggers who publish with GitHub issues and want to edit drafts locally, then publish new posts or update existing ones at any time.
-* Open-source authors who publish documentation through GitHub issues and want to sync docs from the repository to specific issues.
+* Bloggers who publish with GitHub issues and want to edit drafts locally.
+* Open-source authors who publish documentation through GitHub issues.
 * Anyone else who needs to update GitHub issues frequently.
 
 
-## Installation
 
-Install it globally so you can call it from the command line at any time:
+## Installation
 
 ```sh
 npm install -g kup-cli
 ```
 
-(When a new version of Kup is released, run the same command again to upgrade.)
+Install it globally so you can use it anytime, anywhere from the command line. (When a new version of Kup is released, run the same command again to upgrade.)
+
 
 
 ## Usage
@@ -73,17 +75,35 @@ Updating GitHub issues requires authentication, so you need to provide a GitHub
 If Kup cannot read a token from the environment, it will prompt you for one in the terminal.
 
 
+
 ## Command-Line Options
 
-Option | Short | Value Type | Description | Notes
----|---|---|---|---
+Option | Short | Value Type | Description
+---|---|---|---
 `--repo` | `-r` | string | Specify the GitHub repository
-`--id` | `-i` | integer | Specify the issue number | <ul><li>Providing a number means updating an existing issue<li>Omitting it means publishing a new issue</ul>
+`--id` | `-i` | integer | Specify the issue number: <ul><li>Providing a number means updating an existing issue<li>Omitting it means publishing a new issue</ul>
 `--dump` | `-d` | - | Enable dump mode, save a GitHub issue as a local Markdown file
 `--version` | `-v` | - | Show the version number
 `--help` | `-h` | - | Show help information
 
 
+
+&nbsp;
+
+> ***
+>
+> ### **🙋‍♂️ Open to Work (Remote, Global)**
+>
+> * Senior Fullstack Engineer · Node.js, React, Vue, TS · 10+ years
+> * Published author on “AI Coding” · GitHub 3k+ followers
+> * → Resume / Contact: https://github.com/cssmagic/cssmagic
+>
+> ***
+
+&nbsp;
+
+
+
 ## Advanced
 
 ### How can I specify the `repo` option more conveniently?
@@ -132,12 +152,15 @@ What happens if there is no `tags` field in the metadata?
 
 When updating an existing issue, if the labels specified in the metadata differ from the issue's current labels, the new set completely replaces the old one.
 
+
+
 ## Documentation
 
 * [Metadata examples for Markdown files](https://github.com/cssmagic/kup/issues/1)
 * [How to generate an appropriate GitHub token for Kup](https://github.com/cssmagic/kup/issues/17)
 
 
+
 ## Other
 
 ### Roadmap

package/README.zh.md

@@ -4,9 +4,11 @@
 
 <img src="https://user-images.githubusercontent.com/1231359/171321963-e8e73bdf-f9c8-435b-9707-318e92f1805a.png" width="150" height="80" align="right" alt="Kup logo">
 
-> A CLI tool to sync local Markdown files to GitHub issues.
+> A CLI tool to sync local Markdown files and GitHub issues bidirectionally.
 >
-> 这款命令行工具可以把本地的 Markdown 文件同步到 GitHub issue。
+> 一款命令行工具，实现本地 Markdown 文件与 GitHub Issues 的双向同步。
+
+
 
 ## 谁需要它
 
@@ -15,15 +17,15 @@
 * 其它需要频繁更新 GitHub issue 的人。
 
 
-## 安装
 
-需要全局安装，以便随时在命令行调用：
+## 安装
 
 ```sh
 npm install -g kup-cli
 ```
 
-（当 Kup 发布新版时，可以再次运行这行命令升级已安装的版本。）
+需要全局安装，以便随时在命令行调用。（当 Kup 发布新版时，可以再次运行这行命令升级已安装的版本。）
+
 
 
 ## 使用方法
@@ -73,17 +75,19 @@ kup ./path/to/file.md --dump --repo foo/bar --id 123
 如果 Kup 未能从环境变量获取 token，会在命令行向你询问。
 
 
+
 ## 命令行参数
 
-参数 | 短名 | 值类型 | 含义 | 备注
----|---|---|---|---
+参数 | 短名 | 值类型 | 含义
+---|---|---|---
 `--repo` | `-r` | 字符串 | 指定 GitHub 仓库
-`--id` | `-i` | 整数 | 指定 issue 的编号 | <ul><li>指定编号表示更新已有 issue<li>未指定编号则表示发布新 issue</ul>
+`--id` | `-i` | 整数 | 指定 issue 的编号： <ul><li>指定编号表示更新已有 issue<li>未指定编号则表示发布新 issue</ul>
 `--dump` | `-d` | - | 激活采集模式，把 GitHub issue 保存为本地 Markdown 文件
 `--version` | `-v` | - | 显示版本号
 `--help` | `-h` | - | 显示帮助信息
 
 
+
 ## 进阶
 
 ### 如何更方便地指定 `repo` 参数？
@@ -132,12 +136,15 @@ Kup 会通过以下线索来确定 issue 的标题，优先级递减：
 
 在更新已有 issue 时，如果元数据指定的标签与 issue 现有标签不一致，则前者会完全替代后者。
 
+
+
 ## 文档
 
 * [Markdown 文件内的元数据示例](https://github.com/cssmagic/kup/issues/1)
 * [如何为 Kup 生成合适的 GitHub token](https://github.com/cssmagic/kup/issues/17)
 
 
+
 ## 其它
 
 ### 开发计划

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "kup-cli",
-	"version": "0.2.0",
+	"version": "0.2.1",
 	"description": "A CLI tool to sync local Markdown files to GitHub issues.",
 	"type": "module",
 	"bin": {