docs: add README (#41)

* docs: add README * Update README.md Co-authored-by: David Sanders <[email protected]> --------- Co-authored-by: David Sanders <[email protected]>
electron · Apr 5, 2024 · 0d850a1 · 0d850a1
1 parent d4c2b2e
commit 0d850a1
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/README.md 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).