{"id":13818043,"url":"https://github.com/electron-delta/electron-delta","last_synced_at":"2025-10-16T12:58:32.625Z","repository":{"id":37898434,"uuid":"473722397","full_name":"electron-delta/electron-delta","owner":"electron-delta","description":"True delta updates for electronjs","archived":false,"fork":false,"pushed_at":"2022-08-16T18:36:22.000Z","size":3622,"stargazers_count":39,"open_issues_count":3,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-08T16:39:53.184Z","etag":null,"topics":["delta-updates","electron-app","electron-builder","electron-updater","electronjs"],"latest_commit_sha":null,"homepage":"https://electrondelta.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/electron-delta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-24T18:13:14.000Z","updated_at":"2025-01-19T23:15:30.000Z","dependencies_parsed_at":"2022-08-19T23:40:50.317Z","dependency_job_id":null,"html_url":"https://github.com/electron-delta/electron-delta","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-delta%2Felectron-delta","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-delta%2Felectron-delta/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-delta%2Felectron-delta/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-delta%2Felectron-delta/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electron-delta","download_url":"https://codeload.github.com/electron-delta/electron-delta/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238645795,"owners_count":19506913,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["delta-updates","electron-app","electron-builder","electron-updater","electronjs"],"created_at":"2024-08-04T07:00:29.311Z","updated_at":"2025-10-16T12:58:27.586Z","avatar_url":"https://github.com/electron-delta.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"## I'm working on macos delta updates. It's going to come soon. Help required!\n\n# @electron-delta/builder\n\nTrue delta updates for electronjs apps. It reduces the bandwidth usage by 90%. Users download only the delta. It uses binary diffing (`HDiffPatch` library) to generate the delta.\n\n![Delta updates](https://electrondelta.com/assets/delta-downloading.png)\n\n## Requirements\n\n1. The app must use `electron-builder` to build the app.\n2. Currently only `Windows` os is supported. MacOS support is arriving soon.\n3. Target must be `nsis` or `nsis-web`\n\n## Installation\n\n#### Step 1:\n\n```sh\nnpm install @electron-delta/builder -D\n```\n\n#### Step 2:\n\nCreate a file name called `.electron-delta.js` in the root of the project.\n\n#### Step 3:\n\nIn the `electron-builder` config, mention the above file as `afterAllArtifactBuild` hook.\n\n```json\n\"build\": {\n    \"appId\": \"com.electron.sample-app\",\n    \"afterAllArtifactBuild\": \".electron-delta.js\",\n    \"win\": {\n      \"target\": [\"nsis\"],\n      \"publish\": [\"github\"]\n    },\n    \"nsis\": {\n      \"oneClick\": true,\n      \"perMachine\": false,\n    }\n}\n```\n\n#### Step 4:\n\nPaste the following code in the `.electron-delta.js` file. It will be executed after the app is built.\n\n```js\n// .electron-delta.js\nconst DeltaBuilder = require(\"@electron-delta/builder\");\nconst path = require(\"path\");\n\nconst options = {\n  productIconPath: path.join(__dirname, \"icon.ico\"),\n  productName: \"electron-sample-app\",\n\n  getPreviousReleases: async () =\u003e {\n    return [\n      {\n        version: '0.0.12',\n        url: 'https://github.com/electron-delta/electron-sample-app/releases/download/v0.0.12/electron-sample-app-0.0.12.exe'\n      },\n      {\n        version: '0.0.11',\n        url: 'https://github.com/electron-delta/electron-sample-app/releases/download/v0.0.11/electron-sample-app-0.0.11.exe'\n      },\n      {\n        version: '0.0.9',\n        url: 'https://github.com/electron-delta/electron-sample-app/releases/download/v0.0.9/electron-sample-app-0.0.9.exe'\n      }\n    ];\n  },\n  sign: async (filePath) =\u003e {\n    // sign each delta executable\n  },\n};\n\nexports.default = async function (context) {\n  const deltaInstallerFiles = await DeltaBuilder.build({\n    context,\n    options,\n  });\n  return deltaInstallerFiles;\n};\n```\n\n## `options`\n  - `productIconPath`: (required) Path to the icon file. The icon file must be a .ico file.\n  - `productName`: (required) Name of the product.\n  - `getPreviousReleases`: (required) Function to get the previous releases. It must return an array of objects. Each object must have `version` and `url` properties.\n  - `sign`: (required) Function to sign the delta executable.\n  - `cache`: (optional) Path to the cache directory. If not specified, the default cache directory will be used. The default cache directory is `~/.electron-delta/`.\n  - `processName`: (optional) Name of the process. If different from the product name.\n  - `latestVersion`: (optional) Latest version of the product. If not specified, the latest version will be fetched `process.env.npm_package_version`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron-delta%2Felectron-delta","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectron-delta%2Felectron-delta","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron-delta%2Felectron-delta/lists"}