Skip to content
This repository has been archived by the owner on Feb 13, 2024. It is now read-only.

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gaetandezeiraud committed Nov 21, 2020
1 parent a189904 commit b456701
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 16 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018-2020 Dezeiraud
Copyright (c) 2018-2020 Gaëtan Dezeiraud

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![NpmLicense](https://img.shields.io/npm/l/express.svg)

# bsdiff-nodejs
# bsdiff-node
> An binary diff and patch library based on bsdiff algorithm for NodeJS (Windows, Mac, Linux)
<br>
Expand All @@ -13,18 +13,16 @@ If you find this package useful, please don't forget to star ⭐️ the repo, as

## Installation

Install as a dependency for your project (need python 3.x) with Github Packages:
Install as a dependency for your project (need python 3.x):

```bash
npm install @brouilles/bsdiff-nodejs
npm i bsdiff-node
```

See more here https://github.com/Brouilles/bsdiff-nodejs/packages/402771/versions

## Usage

```javascript
const bsdiff = require('@brouilles/bsdiff-nodejs');
const bsdiff = require('bsdiff-node');
bsdiff.diff(oldFile, newFile, patchFile, function(result, err) {}); // Async
bsdiff.patch(oldfile, newfile, patchfile, function(result, err) {}); // Async

Expand Down
15 changes: 6 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
{
"name": "bsdiff-nodejs",
"name": "bsdiff-node",
"description": "An binary diff and patch library based on bsdiff algorithm for NodeJS (Windows, Mac, Linux).",
"version": "2.2.3",
"publishConfig": {
"registry": "https://npm.pkg.github.com/@Brouilles"
},
"version": "2.2.4",
"repository": {
"type": "git",
"url": "git+https://github.com/Brouilles/bsdiff-nodejs.git"
"url": "git+https://github.com/Brouilles/bsdiff-node.git"
},
"main": "index.js",
"scripts": {
Expand All @@ -18,7 +15,7 @@
"binary": {
"module_name": "bsdiff",
"module_path": "./build/Release/",
"host": "https://github.com/Brouilles/bsdiff-nodejs/releases/download/",
"host": "https://github.com/Brouilles/bsdiff-node/releases/download/",
"remote_path": "{version}"
},
"keywords": [
Expand All @@ -28,9 +25,9 @@
"binary patch"
],
"bugs": {
"url": "https://github.com/Brouilles/bsdiff-nodejs/issues"
"url": "https://github.com/Brouilles/bsdiff-node/issues"
},
"homepage": "https://github.com/Brouilles/bsdiff-nodejs",
"homepage": "https://github.com/Brouilles/bsdiff-node",
"author": "Brouilles <contact@exoway.net>",
"license": "MIT",
"gypfile": true,
Expand Down

0 comments on commit b456701

Please sign in to comment.