Skip to content

Commit 7452fc9

Browse files
committed
Update README.md
1 parent 959ac96 commit 7452fc9

File tree

1 file changed

+71
-54
lines changed

1 file changed

+71
-54
lines changed

README.md

Lines changed: 71 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[![GitHub Downloads](https://img.shields.io/github/downloads/django-files/android-client/total?logo=github)](https://github.com/django-files/android-client/releases/latest/download/django-files.apk)
12
[![GitHub Release Version](https://img.shields.io/github/v/release/django-files/android-client?logo=github)](https://github.com/django-files/android-client/releases/latest)
23
[![GitHub Last Commit](https://img.shields.io/github/last-commit/django-files/android-client?logo=github&label=updated)](https://github.com/django-files/android-client/graphs/commit-activity)
34
[![GitHub Top Language](https://img.shields.io/github/languages/top/django-files/android-client?logo=htmx)](https://github.com/django-files/android-client)
@@ -12,11 +13,12 @@
1213

1314
- [Install](#Install)
1415
- [Setup](#Setup)
15-
- [Android Studio](#Android-Studio)
16-
- [Command Line](#Command-Line)
1716
- [Features](#Features)
1817
- [Planned](#Planned)
1918
- [Known Issues](#Known-Issues)
19+
- [Building](#Building)
20+
- [Android Studio](#Android-Studio)
21+
- [Command Line](#Command-Line)
2022
- [Development](#Development)
2123
- [Support](#Support)
2224
- [Contributing](#Contributing)
@@ -31,47 +33,51 @@ The URL to the file is automatically copied to the clipboard and the preview is
3133
| Server | https://github.com/django-files/django-files |
3234
| iOS App | https://github.com/django-files/ios-client |
3335

34-
## Install
36+
# Install
3537

36-
> The app is now signed with a saved certificate allowing for updates starting with 0.0.3
38+
> Django Files is now signed starting at version 0.0.3
3739
3840
- [Download Latest Release](https://github.com/django-files/android-client/releases/latest/download/django-files.apk)
3941

40-
Until the app is published it must be loaded with [ADB](https://developer.android.com/tools/adb) or [Android Studio](https://developer.android.com/studio).
41-
This requires using [Android Studio](#Android-Studio) or the [Command Line](#Command-Line) interface.
42+
_Until the app is published on the play store, you must allow installation of apps from unknown sources._
4243

43-
<details open><summary>Click Here to View Quick CLI Steps</summary>
44+
1. Go to your device settings.
45+
2. Search for "Install unknown apps" or similar.
46+
3. Choose the app you will install the apk file from.
47+
- Select your web browser to install directly from it.
48+
- Select your file manager to open it, locate the APK and install from there.
49+
4. [Download the Latest Release](https://github.com/django-files/android-client/releases/latest/download/django-files.apk).
50+
5. Open the download in the app you selected in step #3.
51+
6. Choose Install and Accept Play Protect notifications.
52+
7. The app is now installed, proceed to [Setup](#Setup).
4453

45-
```shell
46-
$ wget https://github.com/django-files/android-client/releases/latest/download/django-files.apk
47-
$ ls
48-
django-files.apk
54+
## Setup
4955

50-
$ which adb
51-
C:\Users\Shane\Android\sdk\platform-tools\adb.EXE
56+
1. [Install](#Install) and open the app.
57+
2. Enter the URL to your Django Files server.
58+
3. Log in as you normally would on the website.
59+
4. Done! You can now share any file to your Django Files server...
5260

53-
$ adb devices
54-
List of devices attached
55-
RF9M33Z1Q0M device
61+
# Features
5662

57-
$ adb -s RF9M33Z1Q0M install django-files.apk
58-
Performing Incremental Install
59-
Serving...
60-
All files should be loaded. Notifying the device.
61-
Success
62-
Install command complete in 917 ms
63-
```
63+
- Share or Open any file and automatically copy the URL to the clipboard.
64+
- Ability to manually change servers by entering a new URL from the Server List menu.
65+
- Supports Local Login, GitHub OAuth, Google OAuth, Discord OAuth (w/o passkeys).
6466

65-
See below for more details...
67+
## Planned
6668

67-
</details>
69+
- Ability to save multiple servers and switch between them automatically in the Server List menu.
70+
- Ability for the app to log you in if your session is expired or when switching servers.
6871

69-
## Setup
72+
## Known Issues
7073

71-
1. [Install](#Install) and open the app.
72-
2. Enter the URL to your Django Files server.
73-
3. Log in as you normally would on the website.
74-
4. Done! You can now share any file to your Django Files server...
74+
- Login with Discord OAuth passkeys does not work.
75+
- Login with Google OAuth gives an error; however, if you wait ~30 seconds it will succeed.
76+
- The app gets logged out if the session expires; however, sharing continues to work.
77+
78+
# Building
79+
80+
Covers Android Studio and Command Line.
7581

7682
## Android Studio
7783

@@ -82,19 +88,48 @@ https://developer.android.com/studio
8288
2. Ensure that usb or wifi debugging is enabled in the Android developer settings and verify.
8389

8490
3. Then build or run the app on your device.
91+
- Import the Project
92+
- Run Gradle Sync
8593

86-
- Import the Project
87-
- Run Gradle Sync
94+
To Run. Select your device and press Play ▶️
8895

89-
To run, select your device and press Play ▶️
90-
91-
To build:
96+
To Build.
9297

9398
- Select the Build Variant (debug or release)
9499
- Build > Generate App Bundles or APK > Generate APKs
95100

96101
## Command Line
97102

103+
You will need to have [ADB](https://developer.android.com/tools/adb) installed.
104+
105+
_Note: This section is a WIP and contains building instructions for the command line._
106+
107+
<details><summary>Click Here to Download and Install a Release</summary>
108+
109+
```shell
110+
$ wget https://github.com/django-files/android-client/releases/latest/download/django-files.apk
111+
$ ls
112+
django-files.apk
113+
114+
$ which adb
115+
C:\Users\Shane\Android\sdk\platform-tools\adb.EXE
116+
117+
$ adb devices
118+
List of devices attached
119+
RF9M33Z1Q0M device
120+
121+
$ adb -s RF9M33Z1Q0M install django-files.apk
122+
Performing Incremental Install
123+
Serving...
124+
All files should be loaded. Notifying the device.
125+
Success
126+
Install command complete in 917 ms
127+
```
128+
129+
See below for more details...
130+
131+
</details>
132+
98133
1. Download and Install the Android SDK Platform Tools.
99134

100135
https://developer.android.com/tools/releases/platform-tools#downloads
@@ -134,24 +169,6 @@ _Note: you may have to uninstall before installing due to different certificate
134169

135170
For more details, see the [ADB Documentation](https://developer.android.com/tools/adb#move).
136171

137-
# Features
138-
139-
- Share or Open any file and automatically copy the URL to the clipboard.
140-
- Ability to manually change servers by entering a new URL from the Server List menu.
141-
- Supports Local Login, GitHub OAuth, Google OAuth, Discord OAuth (w/o passkeys).
142-
143-
## Planned
144-
145-
- Ability to save multiple servers and switch between them automatically in the Server List menu.
146-
- Ability for the app to log you in if your session is expired or when switching servers.
147-
148-
## Known Issues
149-
150-
- If you enter an incorrect url, you must clear the apps data or reinstall the app.
151-
- The app gets logged out if the session expires; however, sharing continues to work.
152-
- Login with Google OAuth gives an error; however, if you wait ~15 seconds it will succeed.
153-
- Login with Discord OAuth passkeys does not work.
154-
155172
# Development
156173

157174
Android Studio: https://developer.android.com/studio
@@ -179,4 +196,4 @@ You can also support other related projects:
179196

180197
- [Django Files Server](https://github.com/django-files/django-files)
181198
- [Django Files iOS App](https://github.com/django-files/ios-client)
182-
- [Django Files Android App](https://github.com/django-files/django-files)
199+
- [Django Files Android App](https://github.com/django-files/android-client)

0 commit comments

Comments
 (0)