diff --git a/openvscode-staging/DOCS.md b/openvscode-staging/DOCS.md new file mode 100644 index 0000000..96fcf32 --- /dev/null +++ b/openvscode-staging/DOCS.md @@ -0,0 +1,33 @@ +# Home Assistant Slowtech Add-on: Open Visual Studio Code + +This is an Home Assistant add-on that packages [_Open Visual Studio Code_][openvscode], a fully-featured IDE. + +## Installation + +1. Add the _addons_ repository to your Home Assistant instance's repositories list. (See README.md file in the parent directory.) +1. Follow [Home Assistant's instructions][hassio-install-addon] to install the add-on. + +## Configuration + +The port on which the web interface is exposed can be changed in the _Configuration_ tab, under _Network_. + +Note that this parameter is independent from the _Ingress_ integration. Providing `null` as a port will make the add-on only exposed through the _Ingress_ integration. + +## Changelog & Releases + +The add-on versioning follows the [docker container's versioning][dockerhub-releases]. + +## Support + +This repository does not accept inquiries for the moment. + +## Authors & contributors + +The original setup of this repository and packaging work is by Pierre Guillod. + +The backend software is developped by [Anthony 'Frooodle' Stirling][github-gitpod]. + +[openvscode]: https://www.stirlingtools.com/ +[hassio-install-addon]: https://www.home-assistant.io/addons/ +[github-gitpod]: https://github.com/gitpod-io +[dockerhub-releases]: https://hub.docker.com/r/gitpod/openvscode-server