https://github.com/loan-mgt/letterboxd-badge

Showcase your cinematic tastes in your README with a personalized Letterboxd badge!
https://github.com/loan-mgt/letterboxd-badge

badge cinema readme-profile

Last synced: 10 days ago
JSON representation

Showcase your cinematic tastes in your README with a personalized Letterboxd badge!

• Host: GitHub
• URL: https://github.com/loan-mgt/letterboxd-badge
• Owner: loan-mgt
• License: gpl-3.0
• Created: 2024-02-19T21:34:56.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-18T11:38:33.000Z (10 months ago)
• Last Synced: 2024-06-18T13:24:25.220Z (10 months ago)
• Topics: badge, cinema, readme-profile
• Language: JavaScript
• Homepage: https://letterboxd-badge.vercel.app
• Size: 140 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
letterboxd-badge 🎬

  
Showcase your cinematic tastes in your README with a personalized Letterboxd badge!



## Usage

Generate a simple badge by adding the following markdown to your README:

```markdown

![my cinematic taste](https://letterboxd-badge.vercel.app/)

```

or with a custom redirect link

```markdown

[![my cinematic taste](https://letterboxd-badge.vercel.app/)]()

```

Illustration of the letterboxd badge:

![my cinematic taste](https://letterboxd-badge.vercel.app/qypol)

![my cinematic taste](https://letterboxd-badge.vercel.app/qypol?theme=colorMatch)

## Options / Customization

You can customize your URL by passing various options. Here’s an example of how to use them:

```

url?option1=valueofoption1&option2=valueofoption2

```

### Available Options:

| **Option**      | **Description**                                                              | **Values**                                                                 |

|-----------------|------------------------------------------------------------------------------|---------------------------------------------------------------------------|

| `theme`         | Choose the appearance theme for the display.                                  | `classic`: Matches the Letterbox Dark theme.
`colorMatch`: Matches the theme to the film cover. |

| `index`   | Specifies which review to display based on its index.                        | `number`: 0 for the most recent review, 1 for the one before that, etc.   |

### Example:

To use the `classic` theme and show the second most recent review, your URL would look like this:

```

url?theme=classic&reviewIndex=1

```

## Important Note ❗

This is not an official Letterboxd service.

Here’s an improved version of your README with a better-structured table for clarity and easier reference: