Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateReadme ¶
func GenerateReadme(data ReadmeData) ([]byte, error)
GenerateReadme creates the README.pdf content.
Types ¶
type ReadmeData ¶
type ReadmeData struct {
ProjectName string
Holder string
OtherFriends []project.Friend
Threshold int
Total int
Version string
GitHubReleaseURL string
ManifestChecksum string
RecoverChecksum string
Created time.Time
Anonymous bool
RecoveryURL string // Base URL for QR code (e.g. "https://example.com/recover.html")
Language string // Bundle language (e.g. "en", "es"); defaults to "en"
ManifestEmbedded bool // true when manifest is embedded in recover.html
TlockEnabled bool // true when manifest uses time-lock encryption
}
ReadmeData contains all data needed to generate README.pdf
func (ReadmeData) QRContent ¶ added in v0.0.8
func (d ReadmeData) QRContent() string
QRContent returns the string that will be encoded in the QR code. Returns "URL#share=COMPACT". If RecoveryURL is not set, defaults to the production URL.
Click to show internal directories.
Click to hide internal directories.