Skip to content

Latest commit

 

History

History
50 lines (27 loc) · 2.01 KB

README.md

File metadata and controls

50 lines (27 loc) · 2.01 KB
Raw

og-img

📑 Read release notes for multiple packages on a single page

It's a pain to search for release notes of different packages while upgrading a project. That's why created this project.

You can read this tweet for more info

Installation

  1. Clone this repo
  2. npm i and npm run dev

Contributing Guide

There's a rate-limit (10 req/minute) for unauthenticated users for Github's API. That's why I'm caching the response With Cloudflare Worker's KV so you will need to create an account on Cloudflare and install Wrangler CLI (Please Follow the instructions)

Don't worry you won't be charged anything, there's a generous free limit of 100K req/day.

Once the CLI is installed create a KV namespae

  • wrangler kv:namespace create RELEASE & wrangler kv:namespace create RELEASE --preview
  • Replace the id and preview_id (from the second command 👆) in wrangler.toml
  • Now you can run npm run worker-dev to run the worker locally and npm run worker-publish to publish your changes to Cloudflare. (Again you won't be charged anyting for publishing the worker)

Found this useful?

og-img

Tech Stack

This projet uses

__

Love to build stuff?

Connect with me on Twitter or LinkedIn :)