Update README with API breaking changes info #51

jman commented 2022年10月25日 12:08:15 +02:00

Hello @beocode

following up on my comment on issue #34, here's a small proposal to update the README to warn new users that the Weather App won't work out of box.

I think this warning can be removed when the API connection part will be rewritten to use another API but for the time being it is important to warn new users and old users creating new API keys (?).

In addition to this small README change I'd edit the wiki page "Get Started" as shown in my wiki fork.

This small patch is intended to relieve you from the pressure of new users piling up on this issue caused by OWN.

What do you think? Please feel free to adjust wording as you can see fit. Thanks for a review!

Hello @beocode following up on my comment on issue [#34](https://codeberg.org/BeoCode/Weather/issues/34#issuecomment-656695), here's a small proposal to update the README to warn *new users* that the Weather App won't work out of box. I think this warning can be removed when the API connection part will be rewritten to use another API but for the time being it is important to warn new users and old users creating new API keys (?). In addition to this small README change I'd edit the wiki page "Get Started" as shown in [my wiki fork](https://codeberg.org/jman/Weather/wiki/Home). This small patch is intended to relieve you from the pressure of new users piling up on this issue caused by OWN. What do you think? Please feel free to adjust wording as you can see fit. Thanks for a review!

Beowulf commented 2022年10月25日 12:34:30 +02:00

Can you check your GPG signature because you signed your commit but with a GPG key that Codeberg does not know.
Maybe something is wrong with your git config, or you forgot to add your public key in the settings.

Can you check your GPG signature because you signed your commit but with a GPG key that Codeberg does not know. Maybe something is wrong with your git config, or you forgot to add your public key in the settings.

Beowulf commented 2022年10月25日 13:28:47 +02:00

Otherwise it looks good, I would maybe just move it further up that it is more visible. Maybe it would be better directly above "Features" (line 18).

Otherwise it looks good, I would maybe just move it further up that it is more visible. Maybe it would be better directly above "Features" (line 18).

jman commented 2022年10月25日 13:51:32 +02:00

ah thanks for noticing my incomplete setup (I had to setup a Codeberg account just to contribute to your project 😄)

I've amended the commit as per your suggestion. I will then update the wiki.

thanks

ah thanks for noticing my incomplete setup (I had to setup a Codeberg account just to contribute to your project :smile:) I've amended the commit as per your suggestion. I will then update the wiki. thanks

jman commented 2022年10月25日 18:27:08 +02:00

yes please feel free to merge, this tiny contribution is not worth any special recognition 🙃

yes please feel free to merge, this tiny contribution is not worth any special recognition 🙃

jman commented 2022年10月25日 18:33:43 +02:00

The wiki edit I'm afraid will be on you, I think I have no permissions to edit it (am not very familiar with Codeberg, so maybe I'm missing something). For reference, my suggestion is here.

thanks again

The wiki edit I'm afraid will be on you, I think I have no permissions to edit it (am not very familiar with Codeberg, so maybe I'm missing something). For reference, my suggestion [is here](https://codeberg.org/jman/Weather/wiki/Home). thanks again

Beowulf commented 2022年10月25日 18:41:11 +02:00

Updated the wiki, but removed the reference to OneCallApi 3.0, as OCA3 does not work, as these are different routes.
Thanks again for your contribution. (https://codeberg.org/BeoCode/Weather/wiki/Contributors)

Updated the wiki, but removed the reference to OneCallApi 3.0, as OCA3 does not work, as these are different routes. Thanks again for your contribution. (https://codeberg.org/BeoCode/Weather/wiki/Contributors)