Files

Michel Weststrate 8a5860cb78 API reference documentation

Summary:
Documented all exposed Sandy APIs plugin developers should know about.

Honestly didn't proof-read it myself yet, but wanted to publish this diff at least before PTO, so that the information is available to anyone interested / playing with sandy

Reviewed By: jknoxville

Differential Revision: D22976373

fbshipit-source-id: c30918201d2feeb306ca0d9a3ae1ec10bdf7e2f5

2020-08-24 04:57:02 -07:00

src

API reference documentation

2020-08-24 04:57:02 -07:00

package.json

Flipper Release: v0.53.0

2020-08-19 08:22:00 -07: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