Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tomekit committed Jul 23, 2023
1 parent 3aadccf commit 7f81740
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 22 deletions.
2 changes: 0 additions & 2 deletions INITIAL_SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,3 @@ This is so that App have `writeCapabilities` permissions and can set up CORS Rul

#### Copy details over to your device
![API key success prompt](https://github.com/photosync/android-sync-backblaze-b2/blob/master/resources/images/api_key_copy.png?raw=true)

> **Easy way**: You can copy&paste the whole text into: [Browser QR code generator](https://web.syncaware.com/qr) and scan it using the built-in QR scanner in phone app.
13 changes: 0 additions & 13 deletions KNOWN_ISSUES.md

This file was deleted.

30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,28 @@
## Sync for Backblaze B2
# S3Drive [![S3Drive](https://web.s3drive.app/assets/assets/logos/logo_42.png)](https://s3drive.app/)

### Zero Knowledge E2E encrypted storage compatible with any S3 provider

### Support & Bugs
Please use Issues section in order to report any problems you might be having with your app. Please provide as many details as possible, including your device model, Android version and conditions under which the issue has arisen.
<div style="margin-top: 30px;"></div>

### Clients:

Mobile:
- Android <a href="https://play.google.com/store/apps/details?id=com.s3.drive.file.explorer.storage.cloud.manager">Play Store</a>
- iOS <a href="https://apps.apple.com/us/app/s3drive-cloud-storage/id1665135106">App Store</a><br>

### Features
Are you desperately wanting some new feature? Go ahead and create relevant `Issue`, please don't forget to add `[FEATURE]` prefix, so we can distinguish it from yet another bug.
Desktop:
- Windows <a href="https://github.com/s3drive/app/raw/master/release/s3drive-win-x64.exe">exe</a>
- MacOS <a href="https://github.com/s3drive/app/raw/master/release/s3drive-mac-universal.dmg">Mac (dmg)</a>
- Linux <a href="https://github.com/s3drive/app/raw/master/release/S3Drive-x86_64.AppImage">AppImage</a>

### Inquiry
Web: <a href="https://web.s3drive.app">Client-side JS</a>

If you have any other inquiries, reach us on Twitter: https://twitter.com/backblazesync
### Contact
<a href="https://s3drive.app">Website</a><br>
<a href="https://s3drive.canny.io">Roadmap</a><br>
<a href="https://discord.gg/YvxvypRqCu">Discord</a><br>
<a href="https://s3drive.app/feedback">Contact form</a>

### Support & Bugs
Please use [Issues](https://github.com/s3drive/app/issues) in order to report any problems you might be having with S3Drive.
Please provide what platform you use and some details, so we can understand the issue.
34 changes: 34 additions & 0 deletions S3_PROVIDERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## S3 providers

There are many S3 compatible providers which you can choose from.<br>
Each provider has a slightly different pricing model and usually offer a free tier. <br>
We're not affiliated with any company.


### Backblaze B2
<a href="https://www.backblaze.com/b2/cloud-storage.html">Sign up</a><br>
<a href="https://github.com/photosync/android-sync-backblaze-b2/blob/master/INITIAL_SETUP.md">Setup</a>
### Cloudflare R2
<a href="https://www.cloudflare.com/en-gb/products/r2/">Sign up</a><br>
<a href="https://dash.cloudflare.com">Setup</a>
### AWS S3
<a href="https://portal.aws.amazon.com/billing/signup">Sign up</a><br>
<a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html">Setup</a>
### Wasabi
<a href="https://wasabi.com/sign-up/">Sign up</a><br>
<a href="https://docs.wasabi.com/docs/creating-a-bucket">Setup</a>
### Scaleway
<a href="https://console.scaleway.com/register/">Sign up</a><br>
<a href="https://www.scaleway.com/en/docs/storage/object/quickstart/">Setup</a>
### Storj
<a href="https://storj.io/signup">Sign up</a><br>
<a href="https://docs.storj.io/dcs/getting-started/gateway-mt/">Setup</a>
### iDrive E2
<a href="https://app.idrivee2.com/signup">Sign up</a><br>
<a href="https://www.idrive.com/e2/guides/create_bucket">Setup</a>
### MinIO
<a href="https://min.io/download">Download</a>
### Other (not tested / non-exhaustive)
Alibaba Cloud Object Storage Service (OSS), Ceph, China Mobile EOS, Arvan Cloud Object Storage (AOS), DigitalOcean Spaces, Dreamhost, Huawei OBS, IBM COS S3, IONOS Cloud, Qiniu Cloud Object Storage (Kodo), RackCorp Object Storage, Seagate Lyve Cloud, SeaweedFS, StackPath, Tencent Cloud Object Storage (COS)

Does this list need updating? Please <a href="https://github.com/photosync/android-photosync-s3/issues">let us know</a>

0 comments on commit 7f81740

Please sign in to comment.