krombel/electron-universal
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

chore: update README

Browse Source
This commit is contained in:
Samuel Attard
2020-11-13 13:13:39 -08:00
parent 395c31eb71
commit 468883dccb
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -4,13 +4,9 @@
[![CircleCI](https://circleci.com/gh/electron/universal.svg?style=svg)](https://circleci.com/gh/electron/universal) [![CircleCI](https://circleci.com/gh/electron/universal.svg?style=svg)](https://circleci.com/gh/electron/universal)
## Disclaimer
Work In Progress
## Usage ## Usage
```typescript ```typescript
import { makeUniversalApp } from '@electron/universal'; import { makeUniversalApp } from '@electron/universal';
@@ -20,3 +16,17 @@ await makeUniversalApp({
outAppPath: 'path/to/App_universal.app', outAppPath: 'path/to/App_universal.app',
}); });
``` ```
## FAQ
#### The app is twice as big now, why?
Well, a Universal app isn't anything magical. It is literally the x64 app and
the arm64 app glued together into a single application. It's twice as big
because it contains two apps in one.
#### What about native modules?
The way `@electron/universal` works today means you don't need to worry about
things like building universal versions of your native modules. As long as
your x64 and arm64 apps work in isolation the Universal app will work as well.