https://github.com/stephenyeargin/trmnl-open-library

📚 Open Library for TRMNL
https://github.com/stephenyeargin/trmnl-open-library

hacktoberfest open-library open-library-api trmnl trmnl-plugin

Last synced: 3 months ago
JSON representation

📚 Open Library for TRMNL

• Host: GitHub
• URL: https://github.com/stephenyeargin/trmnl-open-library
• Owner: stephenyeargin
• License: mit
• Created: 2025-07-22T17:10:11.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2026-03-29T21:03:23.000Z (3 months ago)
• Last Synced: 2026-03-29T23:48:39.991Z (3 months ago)
• Topics: hacktoberfest, open-library, open-library-api, trmnl, trmnl-plugin
• Language: Liquid
• Homepage: https://usetrmnl.com/recipes/124200
• Size: 298 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# TRMNL Plugin

[![Build and Release](https://github.com/stephenyeargin/trmnl-open-library/actions/workflows/build.yml/badge.svg)](https://github.com/stephenyeargin/trmnl-open-library/actions/workflows/build.yml)

![promo](assets/promo.png)

## Screenshot

![screenshot](assets/screenshot.png)

## Development

### Releasing

This project uses automated releases based on the `VERSION` file. To create a new release:

1. Update the version using the bump script:

   ```bash

   ./bin/bump-version [major|minor|patch]

   ```

2. Commit and push the version change:

   ```bash

   git add VERSION

   git commit -m "Bump version to X.Y.Z"

   git push origin main

   ```

3. The GitHub Action will automatically:

   - Create a git tag for the new version

   - Generate release notes from commits

   - Create a GitHub release

   - Deploy to TRMNL using `trmnlp push`

### Manual Development

For local development and testing:

```bash

# Run development server

./bin/dev

# Push to TRMNL (requires API key configuration)

trmnlp push

```