Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Colony documentation

Sorted by who is reading, not by subject.

Using Colony

guide/tutorial.md getting Colony on your machine, then a first app installed, launched and updated
guide/faq.md where Colony keeps its files, how sign-in and updates work, and what to do when something looks wrong
guide/colony-spec.md for app authors: the colony.json manifest, asset names, signatures, and how to check a manifest before a release

Reading the code

internals/architecture.md where everything lives in src/, how a message flows, and what is cached where
internals/release-signing.md how releases are signed, what Colony checks before it installs or updates, and how the key is rotated
../CONTRIBUTING.md building, testing, the checks a pull request must pass, and adding an app to the catalog

Why it exists

../README.md#why-colony what Colony replaces, and what it does that downloading each release by hand does not