Skip to content
This repository has been archived by the owner on Jul 14, 2023. It is now read-only.

Update README.md for TS compilation #6

Closed
sebapoole opened this issue Nov 5, 2022 · 1 comment
Closed

Update README.md for TS compilation #6

sebapoole opened this issue Nov 5, 2022 · 1 comment

Comments

@sebapoole
Copy link

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
Copy link
Owner

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants