diff --git a/README-ZH.md b/README-ZH.md index 3b3db0b..2192c8b 100644 --- a/README-ZH.md +++ b/README-ZH.md @@ -1,3 +1,3 @@ -# Obsidian Typewriter Sounds +# Obsidian Click Clack -Simulates typewriter sounds in Obsidian.md +在 Obsidian 中模拟机械键盘、打字机按键音。 diff --git a/README.md b/README.md index 0a5f3b7..e0c7231 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ -# Obsidian Typewriter Sounds +# Obsidian Click Clack + +Simulates typewriter sounds in Obsidian.md source: This plugin is still in early development. Listen to key events and play typing sound effect through local resource. -You can install the plugin manully, and please include the unzipped resource folder to the plugin folder, that is ./obsidian/plugins/typewriter-sounds +## Install manually + +Go to the latest release page, download `main.js` and `manifest.json` and put the in the directory of `[yourvault]/.obsidian/plugins/click-clack`. + +A default sound resource is bundled with the plugin. However, if you want more variants, please download the `resources.zip` from the release and include the unzipped resource folder `resources` to the plugin folder. + +## Roadmap + +- Settings interface + - Custom sources (common, return?, ping?,) + - Monkey type + - Mechvibe +- Handle controller chars +- Documentation & Community + - i18n + - README-ZH.md + - Forum + - Forum-zh + - Discord + - Community plugin release diff --git a/styles.css b/styles.css deleted file mode 100644 index 71cc60f..0000000 --- a/styles.css +++ /dev/null @@ -1,8 +0,0 @@ -/* - -This CSS file will be included with your plugin, and -available in the app when your plugin is enabled. - -If your plugin does not need CSS, delete this file. - -*/