Proper documentation

[appetrosyan]

As of now the package's dependencies are completely unknown. Although it can be installed, I don't know how to start it. The official readme should include installation instructions.

[jcs090218]

Hi, thanks for opening this issue!

Do you installed it from melpa? If you did, you can check the package page here. Then you will see the dependencies listed on that page!

[appetrosyan]

yes, from Melpa, and I did see "Grammarly support for Flycheck." as the documentation. As a package that potentially requires much configuration, it really needs more documentation. I'm happy to provide some if you would accept a PR.

[jcs090218]

I would accept a PR if it helps the community! :D Feel free to open it!

[mmagnus]

Yeah, please write more on how to use it. It look exciting!

[jcs090218]

Thanks for being interested! I am not quite sure about the documentation you guys want. I think is pretty straight forward? 😕 You can enabled flycheck then it should work! If it doesn't, then is a bug. 😅

[mmagnus]

OK ;-) yeah, I did that and I didn't work.. I wanted then to change flycheck checkers etc.. but nothing worked, ok, I try again ;)

[mmagnus]

OK, this was required to get this running for my MD files:

(require 'grammarly)
(require 'flycheck-grammarly)
(add-hook 'markdown-mode-hook 'flyspell-grammarly)

@appetrosyan I hope this helps.

@jcs090218 you could give a simple screenshot, you can take mine if you want, and just include this simple setup in the readme. It would help to get quickly what's going on. Now for me this seems obvious...

I developed myself some hacky way to use Grammarly, but it's nothing compared to the native support for Emacs.

[jcs090218]

@mmagnus Interesting..., base on this line https://github.com/jcs-elpa/flycheck-grammarly/blob/72425743364f4fd9516f94546a7432457e1e7df0/flycheck-grammarly.el#L200

Should already have grammarly support in markdown-mode. I guess you would just need to call (require 'flycheck-grammarly) then it should work! Because this package already (require 'grammarly) and once loaded the line above will be called so the markdown-mode, text-mode, etc, will all have flycheck-grammarly support!

[ghost]

I still can't understand where to enter login and password.

[jcs090218]

@lockywolf Hi, here probably not the right place to discuss. You may discuss over here emacs-grammarly/grammarly#1. Hope this helps! :)

[jcs090218]

Just to update this thread, I have added the basic usage in README file. Hope this helps!

[appetrosyan]

Much better. As this is a kelps package, I would also add a version with use-package.