Skip to content

Commit

Permalink
Merge pull request #5 from sviete/readme
Browse files Browse the repository at this point in the history
readme in english
  • Loading branch information
araczkowski authored Sep 2, 2023
2 parents 385218c + b730665 commit 7429375
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
<[email protected]>.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
blank_issues_enabled: false
contact_links:
- name: I have a question or need support
url: https://community.home-assistant.io/t/new-add-on-cloudflared/
about: We use GitHub for tracking bugs, check the community forum for help.
url: https://ai-speaker.discourse.group/
about: Check the community forum for help.
- name: Feature Request
url: https://github.com/sviete/ais-ha-addon-cloudflared/discussions/new
about: Please use create a Discussions for making feature requests.
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ AIS Cloudflare Tunnel.

## About

Cloudflared connects your Home Assistant Instance via a secure tunnel to
your own subdomain at paczka.pro host via Cloudflare.
This allows you to expose your Home Assistant instance to the Internet
without opening ports on your router.
AIS Cloudflared connects your Home Assistant Instance via a secure tunnel to
subdomain selected by you, at paczka.pro host via Cloudflare. Doing that,
you can expose your Home Assistant to the Internet without opening ports
in your router.

![ais tunnel](https://raw.githubusercontent.com/sviete/ais-ha-addon-cloudflared/main/docs/images/ais-tunnel.png)

[:books: Read the full add-on documentation][docs]

Expand Down
9 changes: 5 additions & 4 deletions cloudflared/.README.j2
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ Cloudflared.

## About

Cloudflared connects your Home Assistant Instance via a secure tunnel to a
paczka.pro subdomain at Cloudflare. Doing that, you can expose your Home Assistant to the
Internet without opening ports in your router.
AIS Cloudflared connects your Home Assistant Instance via a secure tunnel to
subdomain selected by you, at paczka.pro host via Cloudflare. Doing that,
you can expose your Home Assistant to the Internet without opening ports in your router.

![ais tunnel](https://raw.githubusercontent.com/sviete/ais-ha-addon-cloudflared/main/docs/images/ais-tunnel.png)

## Disclaimer

Expand All @@ -24,4 +26,3 @@ add-on.
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[releases-shield]: https://img.shields.io/github/v/release/sviete/ais-ha-addon-cloudflared?include_prereleases
[releases]: https://github.com/sviete/ais-ha-addon-cloudflared/releases
[wiki]: https://github.com/sviete/ais-ha-addon-cloudflared/wiki/How-tos

0 comments on commit 7429375

Please sign in to comment.