From c6136396fd79534505c50b3eee78765d29c3bd3e Mon Sep 17 00:00:00 2001 From: Samuel Attard Date: Mon, 26 Oct 2020 15:33:06 -0700 Subject: [PATCH] docs: update usage docs --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 20e1dfa..5220b3a 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,19 @@ [![CircleCI](https://circleci.com/gh/electron/universal.svg?style=svg)](https://circleci.com/gh/electron/universal) +## Disclaimer + +Work In Progress + ## Usage ```typescript import { makeUniversalApp } from '@electron/universal'; + +await makeUniversalApp({ + x64AppPath: 'path/to/App_x64.app', + arm64AppPath: 'path/to/App_arm64.app', + outAppPath: 'path/to/App_universal.app', +}); ```