search

simonpacis / obsidian-grammarly-plugin

Add Grammarly spellchecking to Obsidian.md.
GNU General Public License v3.0
234 stars 11 forks source link

Update README.md for TS compilation #6

Closed sebapoole closed 1 year ago

sebapoole commented 1 year ago

Add steps to the readme for compilation from TS to JS:

## Installation

A quick starting guide for installing the plugin:

-   Download obsidian-grammarly-plugin.zip from the latest release.
    -   Go to: https://github.com/simonpacis/obsidian-grammarly-plugin/releases.
    -   Go to the latest release, click "Assets" and download the zip file from here.
-   Extract the file in a .obsidian/plugins folder in your Vault (.obsidian is probably hidden).
-   Run `npm i` to install dependencies.
-   Run `npm run build` to compile the plugin.
-   Open Obsidian, go to "Community Plugins" and enable "Grammarly Plugin".
simonpacis commented 1 year ago

Hi,

Thank you for this suggestion.

It would, however, be better to have separate steps for using and developing the plug-in.

There is no need to clone the repo to simply use the plug-in. The latest version of the plug-in is always available under "Releases", and the .zip-file from there is what should be installed.

The only reason you'd need to compile it would be if you're working on the plug-in.

Thank you, I'll update the readme.

Best, Simon