Files

Michel Weststrate d5557ef8de Documented so far undocumented top level APIs

Summary: Per title

Reviewed By: passy

Differential Revision: D24992066

fbshipit-source-id: a9aa351600d46a67b605e8555efb30d42ffc2d9b

2020-11-16 13:10:33 -08:00

src

Documented so far undocumented top level APIs

2020-11-16 13:10:33 -08:00

package.json

Flipper Release: v0.65.0

2020-11-11 08:17:41 -08:00

README.md

Initialized flipper-plugin library

2020-07-01 09:12:35 -07:00

tsconfig.json

Allow plugins to send messages

2020-07-01 09:12:36 -07:00

yarn.lock

Initialized flipper-plugin library

2020-07-01 09:12:35 -07:00

README.md

flipper-plugin

flipper-plugin is the dependency used by all modern Flipper plugins (project "Tommy").

For background: https://fb.quip.com/YHOGAnaPqAVJ

flipper-plugin is to be used as dev and peer dependency of all Flipper plugins. It provides:

(TODO) Standard API's to interact with Flipper, such as the client connection.
(TODO) Standard components to organize the UI
(TODO) Testing utilities

API's provided by flipper-plugin are documented at fbflipper.com (TODO).

There should normally be no need to install flipper-plugin as dependency. Rather, plugins should be scaffolded using npx flipper-pkg init (TODO) as documented here