Skip to content

Commit

Permalink
Merge pull request #22 from daltonmenezes/update/docs-and-requirements
Browse files Browse the repository at this point in the history
chore: docs and requirements
  • Loading branch information
daltonmenezes authored Aug 1, 2023
2 parents d0baa01 + 0b014b1 commit 1a7b808
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 3 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@
- 🕸️ All edges connected (APIs to handle all processes)
- 💖 `invoke` and `handle` methods in both processes with the same expected behavior

# Requirements
- Node.js >= 14.0.0
- Electron >= 12.0.0
- TypeScript >= 4.8.0

# 💬 Installation
In your terminal, run:
```bash
Expand Down Expand Up @@ -84,6 +89,8 @@ export const { ipcMain, ipcRenderer, exposeApiToGlobalWindow } =

On the **main process**:

> :warning: Don't forget to add `sandbox: false` to the BrowserWindow because it's required to load the preload script properly!
```ts
import { BrowserWindow, app } from 'electron'

Expand Down
6 changes: 5 additions & 1 deletion apps/web/docs/getting-started/create-a-interprocess.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create a interprocess
order: 3
order: 4
---

# Create a interprocess
Expand Down Expand Up @@ -54,6 +54,10 @@ On the **main process**:

<br />

> ⚠️ Don't forget to add `sandbox: false` to the BrowserWindow because it's required to load the preload script properly!
<br />

```ts
import { BrowserWindow, app } from 'electron'

Expand Down
2 changes: 1 addition & 1 deletion apps/web/docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Installation
order: 2
order: 3
---

# Installation
Expand Down
10 changes: 10 additions & 0 deletions apps/web/docs/getting-started/requirements.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Requirements
order: 2
---

# Requirements

- Node.js >= 14.0.0
- Electron >= 12.0.0
- TypeScript >= 4.8.0
2 changes: 1 addition & 1 deletion packages/interprocess/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"electron": "latest"
},
"peerDependencies": {
"electron": ">=8.0"
"electron": ">=12.0"
},
"keywords": [
"electron",
Expand Down

0 comments on commit 1a7b808

Please sign in to comment.