https://github.com/itchio/wharf-spec

:satellite: A protocol to quickly transfer software builds
https://github.com/itchio/wharf-spec

Last synced: about 2 months ago
JSON representation

:satellite: A protocol to quickly transfer software builds

• Host: GitHub
• URL: https://github.com/itchio/wharf-spec
• Owner: itchio
• Created: 2016-04-07T14:40:50.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-05-22T19:17:16.000Z (over 8 years ago)
• Last Synced: 2024-05-02T06:11:09.008Z (8 months ago)
• Language: Shell
• Homepage: https://docs.itch.ovh/wharf/master
• Size: 23.4 KB
• Stars: 31
• Watchers: 9
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# The wharf specification

Wharf is a protocol that enables incremental uploads and downloads to

keep software up-to-date. It includes:

  * A diffing and patching algorithm, based on rsync

  * An open file format specification for patches and signature files, based on protobuf

  * A [reference implementation][wharf.go] in Go

  * A [command-line tool][butler] with several commands

[wharf.go]: https://github.com/itchio/wharf

[butler]: https://github.com/itchio/butler

## Foreword

Good specifications are easy to read, practical guidelines that make it easier

for software to be interoperable. This book aims to be a good specification.

Its intended audience includes:

  * People who want to understand the tenets of [itch.io][]'s software delivery system,

  to judge its worth / audit it.

  * People who want to write their own, spec-compatible implementation of the protocol

  * People who want to use itch.io's implementation of wharf, but with their own backend.

No spec is perfect, but it is the author's hope that, together with the community,

a solid spec can be achieved and yield numerous highly-compatible implementations.

[itch.io]: https://itch.io

## Links

The latest version of this book is available at:

  * https://docs.itch.ovh/wharf/master/index.html

Contributions can be made to it by submitting pull requests or issues on its GitHub repository:

  * https://github.com/itchio/wharf-spec

## Authors

Except when otherwise noted, this specification has been written by [Amos Wenger][amos]

[amos]: https://github.com/fasterthanlime