Skip to content

Latest commit

 

History

History
 
 

README.md

The adoption kit — bringing habitable to your union

This folder is for the people who introduce habitable to others: organizers running a workshop, coordinators deciding whether a union should adopt it, and the tenants they hand it to. The reference docs (the setup guide, the mobile guide, key management, and the threat model) explain how the tool works. This kit is about helping real people start using it together, calmly and safely.

Alpha software — please read this first. habitable works end to end, but it has not been independently audited or proven in court, and a recorded screen-reader pass and signed app-store binaries are still outstanding. Do not rely on it for a real legal matter yet. Use this kit to practice, to evaluate, and to prepare — not to bet a tenant's case or safety on it today. When that changes, the README and the threat model will say so plainly. See Honest limits.

What's here, and who it's for

File For Use it to
workshop-facilitator-guide.md Organizers / trainers running an onboarding session Run a ~90-minute hands-on workshop (or train another trainer): agenda, prep, a consent/safety segment, and guided practice through install, capture, export, verify, and key backup.
quickstart-en.md Tenants (English) A printable one-page get-started: install, capture an issue, what the statuses mean, keep your evidence safe, and the one big warning.
quickstart-es.md Tenants (Spanish) The same one-pager in natural, plain Spanish. Print and hand out.
board-risk-briefing.md Union boards / decision-makers A short, honest risk-and-benefit briefing for deciding whether to adopt: what it protects, what it does not do, the residual risks, and what adopting responsibly looks like.

How they fit together

This kit is documentation, not legal advice. Work with your tenant attorney or legal-aid group on what to file and when.