[skip ci] docs

This commit is contained in:
ehesp
2019-04-24 11:06:17 +01:00
parent 9df1242036
commit b4eb52b205
4 changed files with 107 additions and 0 deletions

11
docs/storage/android.md Normal file
View File

@@ -0,0 +1,11 @@
---
title: Android Setup
description: Manually integrate Cloud Storage into your Android application.
---
# Android Setup
> The following steps are only required if your environment does not have access to React Native
auto-linking.
## TODO

49
docs/storage/index.md Normal file
View File

@@ -0,0 +1,49 @@
---
title: Cloud Storage
description: Cloud Storage for Firebase is a powerful, simple, and cost-effective object storage service built for Google scale
---
# Cloud Storage
React Native Firebase provides native integration with Cloud Storage, providing support to upload and download files
directly from your device and from your Firebase Cloud Storage bucket.
<Youtube id="_tyjqozrEPY" />
## Getting Started
<Grid>
<Block
icon="cloud_queue"
color="#ffc107"
title="Quick Start"
to="/{{ version }}/storage/quick-start"
>
Install & manage your files with your Firebase storage bucket.
</Block>
<Block
icon="school"
color="#4CAF50"
title="Guides"
to="/guides?tag=storage"
>
TODO
</Block>
<Block
icon="layers"
color="#03A9F4"
title="Reference"
to="/{{ version }}/perf/reference"
>
The API reference covers everything required to successfully integrate Cloud Storage with your application.
</Block>
</Grid>
## 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-storage)
- [Github Issues](https://github.com/invertase/react-native-firebase/issues?utf8=%E2%9C%93&q=is%3Aissue+sort%3Aupdated-desc+label%3Astorage+)
- [Firebase Documentation](https://firebase.google.com/docs/storage?utm_source=invertase&utm_medium=react-native-firebase&utm_campaign=storage)

11
docs/storage/ios.md Normal file
View File

@@ -0,0 +1,11 @@
---
title: iOS Setup
description: Manually integrate Cloud Storage into your iOS application.
---
# iOS Setup
> The following steps are only required if your environment does not have access to React Native
auto-linking.
## TODO

View File

@@ -0,0 +1,36 @@
---
title: Quick Start
description: Get to grips with the basics of Cloud Storage in React Native Firebase
---
# Cloud Storage Quick Start
## Installation
Install this module with Yarn:
```bash
yarn add @react-native-firebase/storage
```
> Integrating manually and not via React Native auto-linking? Check the setup instructions for <Anchor version group href="/android">Android</Anchor> & <Anchor version group href="/ios">iOS</Anchor>.
## Module usage
Import the Cloud Storage package into your project:
```js
import storage from '@react-native-firebase/storage';
```
The package also provides access to the firebase instance:
```js
import { firebase } from '@react-native-firebase/storage';
```
### File uploading
### File downloading
### Changing bucket