/
doc.go
21 lines (16 loc) · 936 Bytes
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Copyright (c) 2018 Dean Jackson <deanishe@deanishe.net>
// MIT Licence - http://opensource.org/licenses/MIT
/*
Package update implements an API for fetching workflow updates from remote servers.
It is the "backend" for aw.Workflow's update API, and provides concrete updaters for
GitHub and Gitea releases, and Alfred metadata.json files (as aw.Options). Updater
implements aw.Updater and you can create a custom Updater to use with
aw.Workflow/aw.Update() by passing a custom implementation of Source to NewUpdater().
The only hard requirement is support for (mostly) semantic version numbers. See
SemVer documentation and http://semver.org for details.
Updater is also Alfred-version-aware, and ignores incompatible workflow version,
e.g. workflow files with the extension ".alfred4workflow" are ignored
when Updater is run in Alfred 3.
See ../_examples/update for one possible way to using the updater API.
*/
package update