Skip to content

Commit

Permalink
Added docs for GitHub Implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
BarryThePenguin committed Sep 14, 2015
1 parent b6acd50 commit 86e59b1
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ using (var mgr = new UpdateManager("http://your-server/releases"))
}
```

### GitHub UpdateManager

To use GitHub Releases as the location where your application updates are hosted:

```cs
var updateManager = UpdateManager.GitHubUpdateManager('https://github.com/myuser/myrepo');

// or to include pre-releases
var updateManager = UpdateManager.GitHubUpdateManager('https://github.com/myuser/myrepo', prerelease: true);
```

Issue #442 contains a brief explanation of how this works.

### Methods for managing updates

These methods are the primary methods you'll use to interact with app updates and apply them.
Expand Down

0 comments on commit 86e59b1

Please sign in to comment.