Skip to content

Commit

Permalink
updated README | bum to v2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
muhammad-usman-anwar committed Aug 19, 2023
1 parent 7b7dda0 commit 064b24f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ It is a rxjs based electron ipc wrapper __V2__, check out [Quick Start](#quick-s

## Notes

**BREAKING CHANGES since v2.2.xx**: Code refactoring was done to better support preload script when __Sandbox__ is enabled. You will need to update the import/require statements, also check out [Sandbox Support](#electron-sandbox-support)

- it is in very early stages(Please do suggest improvements over github).
- I am going to maintain it in two branches(`v1` and `v2`), with different design approaches.
- I have added a quick start guid at the end basing on electron one.
- I have added a quick start guide at the end, based on the electron one.

## Installation

Expand Down Expand Up @@ -321,9 +323,9 @@ import nodeResolve from "@rollup/plugin-node-resolve";
import typescript from "@rollup/plugin-typescript";

export default {
input: './electron/preload.ts',
input: './preload.ts',
output: {
dir: './dist/electron',
dir: './dist',
format: 'cjs',
sourcemap: false,
},
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "electron-reactive-ipc",
"version": "2.1.3",
"version": "2.2.0",
"description": "rxjs based electron IPC channel wrapper",
"main": "lib/index.js",
"types": "lib",
Expand Down

0 comments on commit 064b24f

Please sign in to comment.