TRMNL is an e-ink display that connects with popular products and renders their most useful information. We believe this black & white, focused, hands-off approach is the best way to stay informed without getting distracted.

Our proprietary device is available for purchase at https://usetrmnl.com, however we also provide guides to build your own device, install and mod our open source firmware, and even point your own device (or ours) at your own web server for end-to-end privacy.

See the other repositories in this GitHub organization and our API docs (https://docs.usetrmnl.com) to get started.

Firmware - the PlatformIO project to drive e-ink displays with ESP32

Mounts - clever 3D-printable mounting solutions, submitted by users

Terminus - our flagship self-hosted server in Ruby's Hanami framework

BYOS Laravel - a self-hosted server in PHP's Laravel framework

BYOS Node Lite - a lightweight self-hosted server in Node.js

BYOS Next.js - a self-hosted server in Next.js

BYOS Django - a self-hosted server in Python's Django framework

BYOS Phoenix - a self-hosted server in Elixir's Phoenix framework

Plugins - a collection of community plugins

TRMNLP - a local dev server for rapidly iterating on plugins

TRMNL::I18n - translations for the web app and custom plugins

TRMNL::Liquid - Liquid filters and tags for advanced plugin markup

Mockups - high fidelity render templates to share your work

TRMNL::API - a Ruby gem for interacting with the TRMNL API

Docs - the GitBook documentation at docs.usetrmnl.com

Nook - repurpose an old e-reader

Kobo - repurpose an old e-reader

Amazon Kindle - repurpose an old e-reader

Android - use a tablet or phone

KOReader - repurpose dozens of e-ink devices

iPad - put your dusty old tablet to use

Raspberry Pi - output directly to HDMI or e-ink

Mozilla Firefox - see TRMNL content in new tabs

Google Chrome - see TRMNL content in new tabs