From b61638598d8acc1bc7cbb87e682ea7fbd6f8fa28 Mon Sep 17 00:00:00 2001 From: Erick Zhao Date: Wed, 12 Nov 2025 13:09:18 -0800 Subject: [PATCH] docs: add API docs and clean up README (#155) --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fd8dbab..4a663f4 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![Test](https://github.com/electron/universal/actions/workflows/test.yml/badge.svg)](https://github.com/electron/universal/actions/workflows/test.yml) [![NPM package](https://img.shields.io/npm/v/@electron/universal)](https://npm.im/@electron/universal) +[![API docs](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F%40electron%2Funiversal%2Flatest&query=%24.version&logo=typescript&logoColor=white&label=API%20Docs)](https://packages.electronjs.org/universal) ## Usage @@ -22,6 +23,8 @@ await makeUniversalApp({ }); ``` +For full API usage, see the [API documentation](https://packages.electronjs.org/universal). + ## Advanced configuration The basic usage patterns will work for most apps out of the box. Additional configuration @@ -118,8 +121,4 @@ Note that if you are using `mergeASARs`, you may need to add architecture-specif binary resources to the `singleArchFiles` pattern. See [Merging ASARs usage](#merging-asar-archives-to-reduce-app-size) for an example. -#### How do I build my app for Apple silicon in the first place? - -Check out the [Electron Apple silicon blog post](https://www.electronjs.org/blog/apple-silicon). - [`minimatch`]: https://github.com/isaacs/minimatch?tab=readme-ov-file#features