diff --git a/docs/perf/index.md b/docs/perf/index.md new file mode 100644 index 00000000..5ec933a3 --- /dev/null +++ b/docs/perf/index.md @@ -0,0 +1,70 @@ +--- +title: Performance Monitoring +description: Firebase Performance Monitoring is a service that helps you to gain insight into the performance characteristics of your iOS and Android apps. +--- + +# Cloud Functions + +React Native Firebase provides native integration with Performance Monitoring to gain insight into +key performance characteristics within your React Native application. The library works out of the box, +however provides a simple API to track custom trace and HTTP request metrics. + + + +## Install + +To get started, install the module on your platform: + + + + Follow the Android installation guide. + + + Follow the iOS installation guide. + + + +## Getting Started + + + + Start tracking key performance metrics within your application. + + + Our guides walk you through some of the ways Performance Monitoring can be to gain deeper insight into your applications + performance. + + + The API reference covers everything required to successfully monitor your apps performance. + + + +## Learn more + +Our documentation is a great place to start, however if you're looking for more help or want to help others, +check out the resources below: + +- [Stack Overflow](https://stackoverflow.com/questions/tagged/react-native-firebase-perf) +- [Github Issues](https://github.com/invertase/react-native-firebase/issues?utf8=%E2%9C%93&q=is%3Aissue+sort%3Aupdated-desc+label%3Aperf+) +- [Firebase Documentation](https://firebase.google.com/docs/perf-mon?utm_source=invertase&utm_medium=react-native-firebase&utm_campaign=perf-mon) diff --git a/docs/perf/installation.md b/docs/perf/installation.md new file mode 100644 index 00000000..d693b85e --- /dev/null +++ b/docs/perf/installation.md @@ -0,0 +1,9 @@ +--- +title: Installation +description: Installing Firebase Performance Monitoring for Android & iOS +--- + +# Installation + +TODO + diff --git a/docs/perf/quick-start.md b/docs/perf/quick-start.md new file mode 100644 index 00000000..18245f5b --- /dev/null +++ b/docs/perf/quick-start.md @@ -0,0 +1,15 @@ +--- +title: Quick Start +description: Get to grips with the basics of Performance Monitoring in React Native Firebase +--- + +# Performance Monitoring Quick Start + +## Module usage + +TODO + +## Custom Tracing + +## HTTP Request Tracing +