Skip to content

Commit 834569e

Browse files
committed
Modify README
1 parent 30da220 commit 834569e

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,58 @@
11
# FileShare
2+
3+
Now implement LAN file sharing feature in your Android App using FileShare module with ease!
4+
5+
## Adding FileShare to your Android project
6+
The module is yet to be published in jCenter repository. So, for now, to use the module, you have to include my maven repository in your project's `build.gradle` file in `allprojects`. After adding it will look something like this :
7+
8+
```
9+
allprojects {
10+
repositories {
11+
jcenter()
12+
maven {
13+
url "https://dl.bintray.com/karuppiah7890/maven"
14+
}
15+
}
16+
}
17+
```
18+
19+
And then in your App's `build.gradle` file, put this in `dependencies` :
20+
21+
`compile 'io.github.karuppiah7890:fileshare:0.1.0'`
22+
23+
After adding, it will look something like this :
24+
25+
```
26+
dependencies {
27+
compile fileTree(dir: 'libs', include: ['*.jar'])
28+
androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
29+
exclude group: 'com.android.support', module: 'support-annotations'
30+
})
31+
compile 'io.github.karuppiah7890:fileshare:0.1.0'
32+
compile 'com.android.support:appcompat-v7:25.0.0'
33+
testCompile 'junit:junit:4.12'
34+
}
35+
```
36+
37+
# Demo App
38+
39+
FileSharer is a Demo App that is built using FileShare library. You can see the source code in the FileSharerDemoApp folder. The APK for the Demo App is available in the releases.
40+
41+
I am yet to do some automation. These are the steps to use the App and to see how the Demo App works based on FileShare module
42+
43+
Install the App in two Android devices.
44+
45+
In Receiver device
46+
1. Create WiFi hotspot
47+
2. Open App
48+
3. click "Get File"
49+
4. The app should show a code on top of the button. And say "Listening" as a Toast
50+
51+
In Sender device
52+
1. Connect to hotspot created by receiver
53+
2. Open App
54+
3. Type the code you saw in Receiver device
55+
4. Click "Pick File and Send"
56+
5. Pick a file (only docs can be picked) and select Done on top right
57+
58+
The file should get sent and you will see Toast messages accordingly in between for "Connected" , "Sending file", "Receiving file" etc in the two devices and finally the Receiver device will also show the location of the stored file as a Toast

0 commit comments

Comments
 (0)