From b60a8537fffed788a0211b56d6389bd68de5058f Mon Sep 17 00:00:00 2001 From: Lorenzo Blasa Date: Tue, 12 Sep 2023 03:55:37 -0700 Subject: [PATCH] README cleanup Summary: Making a few changes to make the information more accurate Reviewed By: antonk52 Differential Revision: D49152177 fbshipit-source-id: c6dee089a6e30b96c3b8258ef56bebd6eeefaa56 --- desktop/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/desktop/README.md b/desktop/README.md index 03027a241..04ffb56bb 100644 --- a/desktop/README.md +++ b/desktop/README.md @@ -4,13 +4,13 @@ This folder contains everything to run the Flipper 'Desktop', that is, the UI wh ### Packages provided here: -* flipper-common: utilities & types shared between client, server, flipper-plugin +* flipper-common: utilities & types shared between client, server, and plugins * flipper-server-core: all device & client management goes in here. Basically flipper's backend * flipper-ui-core: all UI goes in here, as far as it doesn't depend on Electron -* flipper-ui-electron: the Electron app, will load server-core and ui-core, and glue them together, providing implementations for some electron * specific stuff like dialgos -* flipper-server: A node process hosting flipper-server-core, that can be connected to over websockets. And probably can serve a browser version of the UI as well. +* app: the Electron app, will load flipper-server-core and flipper-ui-core, and glue them together, providing implementations for some electron specific stuff like dialogs +* flipper-server: A node process hosting flipper-server-core that can be connected to over websockets. Also, it can serve a browser version of the UI as well. * flipper-ui-browser: thin wrapper around flipper-ui-core, providing some browser specific behavior / stubs. -* flipper-dump: (might remove later), but want to hack a quick and dirt flipper dump in here, as alternative way to test flipper-server-core. +* flipper-dump: (might remove later) as an alternative way to test flipper-server-core. * flipper-plugin: The flipper SDK used by plugins. Exposes all API's that can be used by plugins * pkg: CLI tool to manage building flipper plugins * pkg-lib @@ -22,7 +22,7 @@ This folder contains everything to run the Flipper 'Desktop', that is, the UI wh ### Packages overview ``` -flipper-ui-electron: +app: - flipper-server-core (directly embedded) - flipper-ui-core - plugins (prebundled) @@ -32,7 +32,7 @@ flipper-ui-electron: flipper-server - flipper-server-core - flipper-ui-browser (served by webserver) - - flipper-ui-core (communicates using WebSocket with server-core) + - flipper-ui-core (communicates using web sockets with server-core) - plugins (prebundled) - plugins (installable)?