Skip to content

Commit

Permalink
update readme, add screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
Amin Rostami committed Oct 5, 2022
1 parent b85bc79 commit 2f8e214
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
### **Sharing** directory and files from cli to ios and android devices without need of an extra clien app

**Sharing** directory and files from cli to ios and android devices without need of an extra clien app

## Usage
1. install
Expand All @@ -9,4 +8,14 @@
3. scan the QR-Code with your phone
- both devices most connect to the same wifi or if you have public ip address use --ip parameter.
- `sharing --ip your-public-ip-address /directory-or-file-to-share`
4. Tada! just browse the directory and download any file you want
4. Tada! just browse the directory and download any file you want

## Screen-shots
#### sharing a directory and generate access QR-Code:
![Sharing screenshot](/doc/sharing-screenshot.jpeg?raw=true "Sharing a directory")

#### Browsing the shared directory and download files on phone:
![Sharing screenshot](/doc/sharing-on-phone-screenshot.jpeg?raw=true "Browsing the shared directory")

## TODO
- clip board copy (peyman idea)
Binary file added doc/sharing-on-phone-screenshot.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/sharing-screenshot.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2f8e214

Please sign in to comment.