jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove MySonarPlugin from getting-started (#240)

Browse Source 
Summary:
I think the getting-started page should be a no-nonsense quick set of steps to get you up and running so you can try out flipper.

With it referencing the non existent "MySonarPlugin", you can't just follow the steps for it to work. You'd have to either write a plugin which would take a while, or look at the sample apps on your own to see how to add a real plugin. I think it will be far more helpful just to give a working example.
Pull Request resolved: https://github.com/facebook/flipper/pull/240

Reviewed By: passy

Differential Revision: D9378196

Pulled By: jknoxville

fbshipit-source-id: 18ae4a39d09c7baa17adb7f7a71fd766e9bc8e51
This commit is contained in:
John Knox
2018-08-17 07:20:05 -07:00
committed by Facebook Github Bot
parent aedb9c0343
commit 839a579a17
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/getting-started.md
View File

@@ -54,7 +54,7 @@ public class MyApplication extends Application {
if (BuildConfig.DEBUG && SonarUtils.shouldEnableSonar(this)) { if (BuildConfig.DEBUG && SonarUtils.shouldEnableSonar(this)) {
final SonarClient client = AndroidSonarClient.getInstance(this); final SonarClient client = AndroidSonarClient.getInstance(this);
client.addPlugin(new MySonarPlugin()); client.addPlugin(new InspectorSonarPlugin(this, DescriptorMapping.withDefaults()));
client.start(); client.start();
} }
} }
@@ -103,7 +103,9 @@ and install the dependencies by running `pod install`. When you open the Xcode w
{ {
#if DEBUG #if DEBUG
SonarClient *client = [SonarClient sharedClient]; SonarClient *client = [SonarClient sharedClient];
[client addPlugin:[MySonarPlugin new]]; SKDescriptorMapper *layoutDescriptorMapper = [[SKDescriptorMapper alloc] initWithDefaults];
[client addPlugin:[[SonarKitLayoutPlugin alloc] initWithRootNode: application
withDescriptorMapper: layoutDescriptorMapper]];
[client start]; [client start];
#endif #endif
... ...
@@ -121,4 +123,4 @@ and install the dependencies by running `pod install`. When you open the Xcode w
## Ready for takeoff ## Ready for takeoff
Finally, you need to add plugins to your Flipper client. See [Network Plugin](network-plugin.md) and [Layout Inspector Plugin](layout-plugin.md) for information on how to add them. Finally, you need to add plugins to your Flipper client. Above we have only added the Layout Inspector plugin to get you started. See [Network Plugin](network-plugin.md) and [Layout Inspector Plugin](layout-plugin.md) for information on how to add them, and also enable Litho or ComponentKit support. You can check the sample apps in the [GitHub repo](https://github.com/facebook/flipper) for examples of integrating other plugins.