Skip to content

Commit

Permalink
More netdaemon updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ludeeus committed Mar 8, 2020
1 parent 78da41a commit 7263780
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
54 changes: 54 additions & 0 deletions documentation/publish/netdaemon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
id: netdaemon
title: NetDaemon Apps
description: "NetDaemon Apps"
---

A template to use as a reference is [netdaemon-app-template](https://github.com/helto4real/netdaemon-app-template)

## Requirements

For a NetDaemon app repository to be valid these are the requirements:

### Repository structure

- There is only one app (one directory under `ROOT_OF_THE_REPO/apps/`) pr. repository (if you have more, only the first one will be managed.)
- The app (all the python files for it) are located under `ROOT_OF_THE_REPO/apps/APP_NAME/`
- The app and all the python files for it are located under `ROOT_OF_THE_REPO/apps/APP_NAME/`

#### OK example:

```text
apps/awesome/awesome.cs
info.md
README.md
```

#### Not OK example (1):

```text
awesome/awesome.cs
info.md
README.md
```

#### Not OK example (2):

```text
awesome.cs
info.md
README.md
```

### GitHub releases (optional)

#### If there are releases

When installing/upgrading it will scan the content in the latest release.

If there are multiple releases in the repository the user have some options to install a specific version.
The choices will be the last 5 releases and the default branch.

#### If there are no releases

It will scan files in the branch marked as default.
2 changes: 2 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ module.exports = {
"categories/integrations",
"categories/plugins",
"categories/appdaemon_apps",
"categories/netdaemon_apps",
"categories/python_scripts",
"categories/themes"
]
Expand Down Expand Up @@ -59,6 +60,7 @@ module.exports = {
"publish/start",
"publish/appdaemon",
"publish/integration",
"publish/netdaemon",
"publish/plugin",
"publish/python_script",
"publish/theme",
Expand Down

0 comments on commit 7263780

Please sign in to comment.