diff --git a/README.md b/README.md index 825f856..6b779c8 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,11 @@ ts-fsrs is a [ES modules package](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) based on TypeScript, used to implement the [Free Spaced Repetition Scheduler (FSRS) algorithm](https://github.com/open-spaced-repetition/free-spaced-repetition-scheduler). It helps developers apply FSRS to their flashcard applications, there by improving the user learning experience. +The workflow for TS-FSRS can be referenced from the following resources: +> - google driver: [ts-fsrs-workflow.drawio](https://drive.google.com/file/d/1FLKjpt4T3Iis02vjoA10q7vxKCWwClfR/view?usp=sharing) (You may provide commentary) +> - github: [ts-fsrs-workflow.drawio](./ts-fsrs-workflow.drawio) + + # Usage You need to run on Node.js (>=16.0.0) , using the `"type":"module"` by default in `package.json`. diff --git a/README_CN.md b/README_CN.md index 15fb83c..69ce864 100644 --- a/README_CN.md +++ b/README_CN.md @@ -13,6 +13,8 @@ ts-fsrs 是一个基于TypeScript开发的[ES modules包](https://gist.github.co ，用于实现[自由间隔重复调度器（FSRS）算法](https://github.com/open-spaced-repetition/free-spaced-repetition-scheduler/blob/main/README_CN.md) 的工具。它可以帮助开发者将FSRS应用到他们的记忆卡应用中，从而提升用户的学习体验。 +> 你可以通过[ts-fsrs-workflow.drawio](./ts-fsrs-workflow.drawio)来获取ts-fsrs的工作流信息。 + # 使用ts-fsrs 你需要运行在 Node.js (>=16.0.0)上，并且在`package.json`默认使用 `"type":"module"`。 diff --git a/README_JP.md b/README_JP.md index e28ce4d..090b308 100644 --- a/README_JP.md +++ b/README_JP.md @@ -13,6 +13,11 @@ ts-fsrsは[自由間隔重複スケジューラ（FSRS）アルゴリズム](htt を実装するための、TypeScriptで開発された[ESモジュールパッケージ](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) です。このツールは、開発者がFSRSアルゴリズムを彼らのフラッシュカードアプリケーションに適用し、ユーザーの学習体験を向上させるのに役立ちます。 +ts-fsrsのワークフローについては、以下のリソースを参照してください。 +> - google driver: [ts-fsrs-workflow.drawio](https://drive.google.com/file/d/1FLKjpt4T3Iis02vjoA10q7vxKCWwClfR/view?usp=sharing) (コメントを提供できます) +> - github: [ts-fsrs-workflow.drawio](./ts-fsrs-workflow.drawio) + + # ts-fsrsの使用方法 Node.js (バージョン >= 16.0.0)を実行する環境を準備して、`package.json`で`"type":"module"`をデフォルトに設定してください。 diff --git a/ts-fsrs-workflow.drawio b/ts-fsrs-workflow.drawio new file mode 100644 index 0000000..41b57d2 --- /dev/null +++ b/ts-fsrs-workflow.drawio @@ -0,0 +1,178 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +