krasimir / octomments

A small library that offers GitHub issues as comments for your site/blog
https://ocs.now.sh/
MIT License
284 stars 15 forks source link

Clarify instructions for octomments server #31

Closed stevejay closed 4 years ago

stevejay commented 4 years ago

I deployed an installation of octomments server for my website but I had some issues following the instructions in the README file for the server part of octomments. This PR clarifies those instructions according to my understanding of how octomments server should be set up.

The instructions seemed to suggest creating both a Github App and a Github OAuth App. I have changed this to creating just a Github App (since they are preferred nowadays over Github OAuth Apps). However for the Github App to work, it has to be installed in the repo to which the comments feature is to be added (my website in this case). I have added extra instructions for this part of the process.

Thanks for the work on this repo!

krasimir commented 4 years ago

Thanks! 🚀

krasimir commented 4 years ago

By the way, I'm thinking of adding a section "Who is using Octomments". Would you mind sharing a URL?

stevejay commented 4 years ago

@krasimir Can do: this blog