Skip to content

Commit 31c7512

Browse files
authored
Create README.md
1 parent 32a2985 commit 31c7512

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Digital Ocean Spaces Android Example
2+
This is an example project showing how to interact with [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces/) from an Android app.
3+
4+
It relies on the official AWS S3 SDK to upload and download files from a Space, and is a Kotlin app.
5+
6+
🚨 **Note that this is purely sample code** - we don't claim to be showing best practices with this, nor should you ship this code as-is without first testing it yourself. It's meant to demonstrate _how_ you can connect to a Space using the S3 SDK, not how to build a Swift app.
7+
8+
This sample source code forms part of the Getting Started with Spaces course by The Cloud Hub.
9+
10+
## Getting started
11+
To run this sample code:
12+
1. Make sure you have Android Studio and the Android SDK installed
13+
2. Open the project, and then open the `SpacesFileRepository.swift` file
14+
3. Change the `accesskey`, `secretkey` to your Spaces API key (generated (here)[https://cloud.digitalocean.com/account/api/tokens]), `spacename` to the name of your Space on Digital Ocean and `spaceregion` to your Space' region
15+
16+
The project should run, and you'll be able to upload and download the sample image included in the app.

0 commit comments

Comments
 (0)