From a8680c8df6c8ae81daf9365fbae82f9e7f43c0c4 Mon Sep 17 00:00:00 2001
From: Pascal Hartig <realpassy@fb.com>
Date: Thu, 21 Nov 2019 08:47:42 -0800
Subject: [PATCH] Add a note about no-op package

Summary: I hope this will lower the support load for this a little.

Reviewed By: jknoxville

Differential Revision: D18638565

fbshipit-source-id: 57ce7f6855817a49bafab35517cf1e8ef2bc2e1e
---
 docs/getting-started.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/getting-started.md b/docs/getting-started.md
index d1829b5af..fe0d240d9 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -50,6 +50,19 @@ dependencies {
 }
 ```
 
+<div class="warning">
+
+Please note that our `flipper-noop` package provides a limited subset of the
+APIs provided by the `flipper` package and does not provide any plugin stubs.
+It is recommended that you keep all Flipper instantiation code in a separate
+build variant to ensure it doesn't accidentally make it into your production
+builds. Check out [the sample
+app](https://github.com/facebook/flipper/tree/master/android/sample/src) to
+see how to organise your Flipper initialization into debug and release
+variants.
+
+</div>
+
 Now you can initialize Flipper in your Application's `onCreate` method, which involves
 initializing SoLoader (for loading the C++ part of Flipper) and starting a `FlipperClient`.