https://github.com/ably/xdelta-async-nodejs-addon

Asynchronous native addon for Node.js for generation and application of patches in VCDIFF format using the Xdelta algorithm
https://github.com/ably/xdelta-async-nodejs-addon

Last synced: 9 months ago
JSON representation

Asynchronous native addon for Node.js for generation and application of patches in VCDIFF format using the Xdelta algorithm

• Host: GitHub
• URL: https://github.com/ably/xdelta-async-nodejs-addon
• Owner: ably
• License: other
• Created: 2019-03-25T19:36:24.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2025-01-17T13:29:21.000Z (over 1 year ago)
• Last Synced: 2025-08-15T12:53:21.177Z (10 months ago)
• Language: C++
• Homepage:
• Size: 1.65 MB
• Stars: 2
• Watchers: 8
• Forks: 4
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# xdelta-async-nodejs-addon

[![Build Status](https://travis-ci.org/ably/xdelta-async-nodejs-addon.svg?branch=main)](https://travis-ci.org/ably/xdelta-async-nodejs-addon)

[![npm version](https://badge.fury.io/js/xdelta-async-nodejs-addon.svg)](https://badge.fury.io/js/xdelta-async-nodejs-addon)

Asynchronous native addon for Node.js that allows generating and applying diffs/patches in VCDIFF format using the [xdelta](https://github.com/jmacd/xdelta) algorithm.

# Usage

The repo could be imported as npm package by adding 

```

"dependencies":  {

  ...

  "xdelta": "git://github.com/ably/xdelta-async-nodejs-addon.git",

  ...

}

```

to your package.json.

# Caveats

The build infrastructure of the addon currently depends on tools that are Mac and Linux specific. Consequently, an installation on Windows will not be possible at this time.

# Release checklist

1. Run `grunt release:` (where `type` is "major", "minor", "patch", "prepatch")

2. Run `grunt release:deploy`

3. Visit [https://github.com/ably/xdelta-async-nodejs-addon/tags](https://github.com/ably/xdelta-async-nodejs-addon/tags) and draft new release for the newly created tag

# License

Copyright (c) 2019 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0.  Refer to [LICENSE](LICENSE) for the license terms.