diff --git a/README.md b/README.md index 3a608065..30a820fe 100644 --- a/README.md +++ b/README.md @@ -1,103 +1,4 @@ -

- -
-
-

React Native Firebase

-

+# Introduction -

- NPM downloads - NPM version - License - Maintained with Lerna -

+This file file serves as your book's preface, a great place to describe your book's content and ideas. -

- Chat on Discord - Follow on Twitter - Follow on Facebook -

- ---- - -> Looking for the legacy version of React Native Firebase? See the [v5.x.x branch](https://github.com/invertase/react-native-firebase/tree/v5.x.x). - ---- - -**React Native Firebase** is a collection of official React Native modules connecting you to Firebase services; each module is a light-weight javascript layer connecting you to the native Firebase SDKs for both iOS and Android. - -React Native Firebase is built with four key principals in mind; - -- ๐Ÿงช **Well tested** - - every module is extensively tested to >95% coverage -- ๐Ÿ‘ **Well typed** - - first class support for Typescript included -- ๐Ÿ“„ **Well documented** - - full reference & installation documentation alongside detailed guides and FAQs -- ๐Ÿ”ฅ **Mirrors official Firebase Web SDK** - - functions as a drop-in replacement for the Firebase Web SDK in React Native - - maximises cross-platform code re-usability e.g. re-using code on web platforms - -## Firebase Modules - -This is the root of the monorepo for React Native Firebase, if you're looking for a specific package please select the package link from below. - -The main package that you interface with is `App` (`@react-native-firebase/app`) - -| Name | Downloads | Coverage | -| -------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | -| [AdMob](/packages/admob) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/admob.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/admob) | [![badge](https://api.rnfirebase.io/coverage/admob/badge)](https://api.rnfirebase.io/coverage/admob/detail) | -| [Analytics](/packages/analytics) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/analytics.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/analytics) | [![badge](https://api.rnfirebase.io/coverage/analytics/badge)](https://api.rnfirebase.io/coverage/analytics/detail) | -| [App](/packages/app) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/app.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/app) | [![badge](https://api.rnfirebase.io/coverage/app/badge)](https://api.rnfirebase.io/coverage/app/detail) | -| [Authentication](/packages/auth) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/auth.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/auth) | [![badge](https://api.rnfirebase.io/coverage/auth/badge)](https://api.rnfirebase.io/coverage/auth/detail) | -| [Cloud Firestore](/packages/firestore) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/firestore.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/firestore) | [![badge](https://api.rnfirebase.io/coverage/firestore/badge)](https://api.rnfirebase.io/coverage/firestore/detail) | -| [Cloud Functions](/packages/functions) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/functions.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/functions) | [![badge](https://api.rnfirebase.io/coverage/functions/badge)](https://api.rnfirebase.io/coverage/functions/detail) | -| [Cloud Messaging](/packages/messaging) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/messaging.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/messaging) | [![badge](https://api.rnfirebase.io/coverage/messaging/badge)](https://api.rnfirebase.io/coverage/messaging/detail) | -| [Cloud Storage](/packages/storage) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/storage.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/storage) | [![badge](https://api.rnfirebase.io/coverage/storage/badge)](https://api.rnfirebase.io/coverage/storage/detail) | -| [Crashlytics](/packages/crashlytics) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/crashlytics.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/crashlytics) | [![badge](https://api.rnfirebase.io/coverage/crashlytics/badge)](https://api.rnfirebase.io/coverage/crashlytics/detail) | -| [Dynamic Links](/packages/dynamic-links) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/dynamic-links.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/dynamic-links) | [![badge](https://api.rnfirebase.io/coverage/dynamic-links/badge)](https://api.rnfirebase.io/coverage/dynamic-links/detail) | -| [In-app Messaging](/packages/in-app-messaging) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/in-app-messaging.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/in-app-messaging) | [![badge](https://api.rnfirebase.io/coverage/in-app-messaging/badge)](https://api.rnfirebase.io/coverage/in-app-messaging/detail) | -| [Instance ID](/packages/iid) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/iid.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/iid) | [![badge](https://api.rnfirebase.io/coverage/iid/badge)](https://api.rnfirebase.io/coverage/iid/detail) | -| [ML Kit Natural Language](/packages/ml-natural-language) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/ml-natural-language.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/ml-natural-language) | [![badge](https://api.rnfirebase.io/coverage/ml-natural-language/badge)](https://api.rnfirebase.io/coverage/ml-natural-language/detail) | -| [ML Kit Vision](/packages/ml-vision) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/ml-vision.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/ml-vision) | [![badge](https://api.rnfirebase.io/coverage/ml-vision/badge)](https://api.rnfirebase.io/coverage/ml-vision/detail) | -| [Performance Monitoring](/packages/perf) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/perf.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/perf) | [![badge](https://api.rnfirebase.io/coverage/perf/badge)](https://api.rnfirebase.io/coverage/perf/detail) | -| [Realtime Database](/packages/database) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/database.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/database) | [![badge](https://api.rnfirebase.io/coverage/database/badge)](https://api.rnfirebase.io/coverage/database/detail) | -| [Remote Config](/packages/remote-config) | [![badge](https://img.shields.io/npm/dm/@react-native-firebase/remote-config.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@react-native-firebase/remote-config) | [![badge](https://api.rnfirebase.io/coverage/remote-config/badge)](https://api.rnfirebase.io/coverage/remote-config/detail) | - -## Documentation - -- [Overview](https://invertase.io/oss/react-native-firebase) -- [Quick Start](https://invertase.io/oss/react-native-firebase/quick-start) -- [Guides](https://invertase.io/oss/react-native-firebase/guides) -- [Modules](https://invertase.io/oss/react-native-firebase/v6) - -## Contributing - -- [Overview](https://invertase.io/oss/react-native-firebase/contributing) -- [Issues & PRs](https://invertase.io/oss/react-native-firebase/contributing/issues-prs-pm) -- [Documentation](https://invertase.io/oss/react-native-firebase/contributing/documentation) -- [Code & Testing](https://invertase.io/oss/react-native-firebase/contributing/code-testing-review) -- [Marketing & Content](https://invertase.io/oss/react-native-firebase/contributing/marketing-content) -- [Community](https://invertase.io/oss/react-native-firebase/contributing/community) -- [Donating](https://invertase.io/oss/react-native-firebase/contributing/donations-expenses) -- [Code of Conduct](/CODE_OF_CONDUCT.md) - -## License - -- See [LICENSE](/LICENSE) - ---- - -

- -

- Built and maintained with ๐Ÿ’› by Invertase. -

-

- ๐Ÿ’ผ Hire Us | - โ˜•๏ธ Sponsor Us | - โ€๐Ÿ’ป Work With Us -

-

- ---- diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 00000000..05d34b1a --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,8 @@ +# Table of contents + +* [Introduction](README.md) + +## Methods + +* [Defining Methods](methods/methods.md) + diff --git a/methods/methods.md b/methods/methods.md new file mode 100644 index 00000000..c2545c46 --- /dev/null +++ b/methods/methods.md @@ -0,0 +1,32 @@ +# Defining Methods + +Methods allow you to smoothly display code examples in different languages. + +## My first method + +My first method exposes how to print a message in JavaScript and Go. + +{% tabs %} +{% tab title="JavaScript" %} +Here is how to print a message to `stdout` using JavaScript. + +```javascript +console.log('My first method'); +``` +{% endtab %} + +{% tab title="Go" %} +Here is how to print a message to `stdout` using Go. + +```go +fmt.Println("My first method") +``` +{% endtab %} +{% endtabs %} + +Whatever language you are using, the result will be the same. + +```bash +$ My first method +``` +