From 0d850a19a84c04d90a35fe16800750772a0a560c Mon Sep 17 00:00:00 2001 From: Erick Zhao Date: Fri, 5 Apr 2024 13:31:08 -0700 Subject: [PATCH] docs: add README (#41) * docs: add README * Update README.md Co-authored-by: David Sanders --------- Co-authored-by: David Sanders --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..36afe33 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# releases.electronjs.org + +This repository contains code for https://releases.electronjs.org, which provides release status information for +the [Electron](https://github.com/electron/electron) project. + +## Getting started + +The website is a simple Node.js app built using [Express](https://expressjs.com/) and [Handlebars.js](https://handlebarsjs.com/). + +### Installation + +To run the app locally, install dependencies and run the `start` script: + +``` +yarn +yarn start +``` + +When developing locally, you may want to use the `watch` script instead, which watches for file changes using [nodemon](https://github.com/remy/nodemon). + +### GitHub Authentication + +The app pulls release information from GitHub, and local usage (especially going through pages of past releases) may hit the rate limit for anonymous GitHub usage. You can provide a GitHub Personal Access Token (PAT) by setting the `GITHUB_TOKEN` environment variable before running the app locally, which will have higher rate limits. + +## License + +Distributed under the [MIT License](https://github.com/electron/release-status/blob/main/LICENSE).