diff --git a/.github/workflows/manual.yml b/.github/workflows/manual.yml index e4ba246..9513720 100644 --- a/.github/workflows/manual.yml +++ b/.github/workflows/manual.yml @@ -1,6 +1,6 @@ # This is a basic workflow that is manually triggered -name: Manual workflow +name: Automatic analysis # Controls when the action will run. Workflow runs when manually triggered using the UI # or API. diff --git a/README.md b/README.md index b1bb388..4a3175e 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,18 @@ # typora Cracker +![GitHub Repo stars](https://img.shields.io/github/stars/Mas0nshi/typoraCracker) +![GitHub release (latest by date)](https://img.shields.io/github/v/release/Mas0nshi/typoraCracker) +![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/m/Mas0nshi/typoraCracker) +![GitHub Release Date](https://img.shields.io/github/release-date/Mas0nshi/typoraCracker) +![GitHub issues](https://img.shields.io/github/issues-raw/Mas0nshi/typoraCracker?color=ff69b4) +![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/Mas0nshi/typoraCracker) + + ![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FMas0nShi%2FtyporaCracker.svg?type=shield) ![GitHub](https://img.shields.io/github/license/Mas0nShi/typoraCracker) +[![Automatic analysis](https://github.com/Mas0nShi/typoraCracker/actions/workflows/manual.yml/badge.svg)](https://github.com/Mas0nShi/typoraCracker/actions/workflows/manual.yml) + A extract & decryption and pack & encryption tools for typora. @@ -34,13 +44,14 @@ ANY PROBLEMS ARISING FROM THIS WILL BE BORNE BY THE USER (YOU). ## Usage - -1. `pip install -r requirements.txt` -2. `python typora.py --help` -3. read and use. -4. do something. -5. pack and replace app.asar. -6. enjoy it. +1. download in [Release Pages](https://github.com/Mas0nShi/typoraCracker/releases) +2. unzip +3. `pip install -r requirements.txt` +4. `python typora.py --help` +5. read and use. +6. do something. +7. pack and replace app.asar. +8. enjoy it. ## Example diff --git a/README_CN.md b/README_CN.md index e2cf0ff..7096916 100644 --- a/README_CN.md +++ b/README_CN.md @@ -31,12 +31,14 @@ ## 食用方式 -1. `pip install -r requirements.txt` -2. `python typora.py --help` -3. 阅读帮助文档及使用。 -4. 做你想做的事。 -5. 打包并替换原目录下的 app.asar。 -6. 享受成果。 +1. 前往[Release Pages](https://github.com/Mas0nShi/typoraCracker/releases) 下载对应版本 +2. 解压 +3. 安装依赖:`pip install -r requirements.txt` +4. 使用说明:`python typora.py --help` +5. 使用。 +6. 做你想做的事。 +7. 打包并替换原目录下的 app.asar。 +8. 享受成果。 ## 示例