From c91665fb5c4f26dbad6c070df50599d25807c231 Mon Sep 17 00:00:00 2001 From: Tal Wrii Date: Fri, 14 Feb 2025 18:26:49 +0100 Subject: [PATCH] tweak readme --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e5cec10..d2532c4 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ npm install npm run dev ``` -You should then be able to enable the plugin in the "Community Plugins" section of settings. +You should then be able to enable the plugin in the "Community Plugins" section of Obsidian's settings. ## Using For basic usage, write a JavaScript expression on a line, then run the command "Execute the current line or selection" in the Command Palette. You can also select a region and run this command. @@ -194,13 +194,13 @@ Modules in Obsidian work in an interesting way that makes installing from NPM a There is a system to provide imports to Plugin REPL provided by [this repository](https://github.com/talwrii/plugin-repl-imports). To use it, you have to checkout a repository into your vault, update a text file, run a make command and then you can use the `replRequire` function within Obsidian, as described in the [docs](https://github.com/talwrii/plugin-repl-imports). -## Some questions and answers about plugin repl +## Some questions and answers about Plugin REPL [Questions and answers](questions.md) ## Alternatives and prior work * You can [use plugins](https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin) to do the same things that you can do with Plugin REPL but this tends to mean more code. * [js-engine](https://github.com/mProjectsCode/obsidian-js-engine-plugin) lets you evaulate JavaScript code in code blocks. [Execute code](https://github.com/twibiral/obsidian-execute-code) gives you code blocks in multiple programming languages. Neither give you access to Obsidian api objects to let you do scripting. -* [dataview](https://blacksmithgu.github.io/obsidian-dataview/) similarly lets you execute JavasSript in code blocks. It gives you access to the `app` object. +* [dataview](https://blacksmithgu.github.io/obsidian-dataview/) similarly lets you execute JavaScript in code blocks. It gives you access to the `app` object. * [Templater](https://github.com/SilentVoid13/Templater) defines a template language with JavaScript code blocks. It's API gives you access to the `app` object and people have used "Templates" that when run script Obsidian. Many plugins can create commands at run time from within Obsidian - but they tend to be for more specific uses. I was influenced by [obsidian-open-settings](https://github.com/Mara-Li/obsidian-open-settings) for this, as well as for the `openSettings` command. @@ -219,9 +219,8 @@ This plugin is highly influenced by [Emacs](https://www.gnu.org/software/emacs/) This code exposes and wraps the [Obsidian plugin API](https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin) - as all plugins do - but Plugin REPL does this in a rather more direct / turing-complete way. ## About me -*If you are interesting in this you might be interested in my [obsidian cookbook](https://medium.com/@readwithai/youtube-shorts-introduction-to-obsidian-56bd01506fa0).* - I make productivity tools and AI tools related to reading and research. + If that sounds interesting you can follow me on twitter or bluesky. I write about these topics on substack.