search

EdJoPaTo / website-stalker

Track changes on websites via git
GNU Lesser General Public License v2.1
59 stars 6 forks source link

What's the purpose of `from:`? #37

Closed rEnr3n closed 3 years ago

rEnr3n commented 3 years ago

Describe your goal I just followed the example and put my email address instead.

Expected I expected my email address but it's not showing up on git logs. This is what I see in the log instead Author: website-stalker/0.12.1 <website-stalker-git-commit@edjopato.de>

EdJoPaTo commented 3 years ago

From is used as an HTTP Header: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/From Its also linked in the README but its not very obvious currently. Any ideas how to improve that?

The idea here is to provide a way to be contacted. As every user of this tool can for example use the tool every minute the website providers can contact you and say "something is wrong, please fix that". The alternative there is to just get blocked.

Besides the tool is being called "stalker" I want to be nice to the hosts of the websites. I dont want to spam them and I want to at least provide a way to be contacted. If they use it or just block the requests is on their side then.

rEnr3n commented 3 years ago

When I installed this app the first time, I looked at the the main instructions of the usage. The ones inside ```. The other details like the link you gave are automatically skipped by my eyes.

When I go back looking for some reference, I went to the config example. From there I read more stuff and read slowly.

I suggest adding explanation of From inside config example.

Another thing, could you enable discussions for this repo?

EdJoPaTo commented 3 years ago

Do you think fc6707e is helpful? Do you have other suggestions?

rEnr3n commented 3 years ago

Sorry. I actually meant below Config Example and above Editors, an h3 header on its own. I don't frequently read comments on the config example. It happened one time only. I tend to frequent the Editors like a glossary.

EdJoPaTo commented 3 years ago

I think this should help now: ec411a0

rEnr3n commented 3 years ago

Thank you much! :smile: