diff --git a/README.md b/README.md index 32ba1aa..b240f6e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Obsidian Plugins Comment +# Obsidian Plugin Comment -Obsidian Plugins Comment is a plugin for [Obsidian](https://obsidian.md) that allows users to add personal annotations to each installed plugin. This is particularly useful for keeping track of why certain plugins are installed and their specific use cases. +Obsidian Plugin Comment is a plugin for [Obsidian](https://obsidian.md) that allows users to add personal annotations to each installed plugin. This is particularly useful for keeping track of why certain plugins are installed and their specific use cases. ## Features @@ -10,8 +10,8 @@ Obsidian Plugins Comment is a plugin for [Obsidian](https://obsidian.md) that al ## Installation -1. Download the latest release from the [Releases](https://github.com/alberti42/obsidian-plugins-comment/releases) page. -2. Extract the files into your Obsidian plugins folder: `/.obsidian/plugins/plugins-comment`. +1. Download the latest release from the [Releases](https://github.com/alberti42/obsidian-plugin-comment/releases) page. +2. Extract the files into your Obsidian plugins folder: `/.obsidian/plugins/obsidian-plugin-comment`. 3. Enable the plugin in the "Community plugins" settings pane. ## Usage @@ -32,3 +32,29 @@ To contribute to the development of this plugin, follow these steps: 2. Clone your forked repository: ```sh git clone https://github.com/your-username/obsidian-plugin-comment.git + ``` +3. Navigate to the plugin directory: + ```sh + cd obsidian-plugin-comment + ``` +4. Install the dependencies: + ```sh + npm install + ``` +5. Build the plugin: + ```sh + npm run build + ``` +6. Enable the plugin in Obsidian and start developing! + +## Donations +I would be grateful for any donation to support the development of this plugin. + +[Buy Me a Coffee QR Code](https://buymeacoffee.com/alberti) + +## Author +- **Author:** Andrea Alberti +- **GitHub Profile:** [alberti42](https://github.com/alberti42) +- **Donations:** [![Buy Me a Coffee](https://img.shields.io/badge/Donate-Buy%20Me%20a%20Coffee-orange)](https://buymeacoffee.com/alberti) + +Feel free to contribute to the development of this plugin or report any issues in the [GitHub repository](https://github.com/alberti42/obsidian-plugin-comment/issues).