wip

Author: silesky

packages/signals/signals/README.md

@@ -55,23 +55,8 @@ analytics.load({
 })
 
 ```
-### Extending / Emitting Custom Signals
-```ts
-import { signalsPlugin } from './analytics' // assuming you exported your plugin instance.
-
-signalsPlugin.addSignal({ someData: 'foo' }) 
-
-// emits a signal with the following shape
-{ 
-  type: 'userDefined' 
-  data: { someData: 'foo', ...  }
-}
-```
-
-### Debugging
-#### Enable debug mode
-Values sent to the signals API are redacted by default.
-This adds a local storage key.  To disable redaction, add a magic query string:
+### Sending and Viewing Signals on Segment.com (Debug mode)
+For privacy reasons, **signals are only to Segment.com when debug mode is on**. You must enable debug mode on the client to send and view those signals on segment.com. To enable debug mode on your client
 ```
 https://my-website.com?segment_signals_debug=true
 ```
@@ -83,20 +68,29 @@ https://my-website.com?segment_signals_debug=false
 * This also logs all signals to the js console.
 
 #### Alternative method(s) of enabling debug mode
-1. In your JS console:
+### Enable debug mode from your JS console:
 ```js
 window.SegmentSignalsPlugin.debug() 
 ```
 
+### Extending / Emitting Custom Signals
+```ts
+import { signalsPlugin } from './analytics' // assuming you exported your plugin instance.
 
-2. Passed as a setting
-```js
-const signalsPlugin = new SignalsPlugin({
-   enableSignalsIngestion: process.env.SEGMENT_SIGNALS_DEBUG === 'true'
-})
-analytics.register(signalsPlugin)
+signalsPlugin.addSignal({ someData: 'foo' }) 
+
+// emits a signal with the following shape
+{ 
+  type: 'userDefined' 
+  data: { someData: 'foo', ...  }
+}
 ```
 
+### Debugging  
+Debug mode **MUST** be enabled on the client to VIEW signals on segment.com.
+
+
+
 ### Advanced
 
 #### Listening to signals