Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mnaoumov committed Sep 15, 2024
1 parent 228d858 commit f846d1d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Validates if TypeScript code compiles.
npx obsidian-dev-utils dev
```

Compiles the development version of your plugin into the `dist/dev` folder. If the environment variable `OBSIDIAN_CONFIG_DIR` is set (e.g., `path/to/my/vault/.obsidian`), the command automatically copies the compiled plugin to the specified Obsidian configuration directory and triggers the [Hot Reload](https://github.com/pjeby/hot-reload) plugin, if installed. Also `.env` supported.
Compiles the development version of your plugin into the `dist/dev` folder. The `OBSIDIAN_CONFIG_DIR` can be set either as an environment variable or specified in a `.env` file (e.g., `path/to/my/vault/.obsidian`). The command automatically copies the compiled plugin to the specified Obsidian configuration directory and triggers the [Hot Reload] plugin, if it is enabled. If the [Hot Reload] plugin is not installed, it will be installed automatically, and you will need to enable it manually.

#### Lint Code

Expand Down Expand Up @@ -144,3 +144,5 @@ obsidianDevUtils.obsidian.Plugin.PluginSettings.loadPluginSettings(() => ({ key:
## License

© [Michael Naumov](https://github.com/mnaoumov/)

[Hot Reload]: https://github.com/pjeby/hot-reload

0 comments on commit f846d1d

Please sign in to comment.