Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dubasdey committed Jan 19, 2016
1 parent 4a63cd4 commit e39b039
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,36 @@
![GPLv3](http://img.shields.io/badge/license-GPLv3-blue.svg)
[![Build Status](https://travis-ci.org/dubasdey/portable-ftp-server.svg?branch=master)](https://travis-ci.org/dubasdey/portable-ftp-server)

Information
-----------------------------------------------------------------------------------------

Portable FTP server for Windows, Linux & Mac. Use with command line or GUI. Requires Java 1.7 or upper


How To Use
-----------------------------------------------------------------------------------------

Execute from graphical interface:
* All-in-one JAR. For GUI just download and double click.

Execute from command line:
* run
```sh
java -jar PortableFtpServer.jar <port> <user> <password> <folder>
```

When:
* *port* is the port used for the FTP server
* *user* is the username to login in the server
* *password* is the password to use for the user
* *folder* is an absolute path to the folder used as FTP root

By deault there is allowed only access for the desired user/password to the folder selected as root for R/W



Donate
-----------------------------------------------------------------------------------------
Buy me a coffe to help me continue supporting this project.
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=U8X6R5QYHRSCY">Buy me a coffe</a>

0 comments on commit e39b039

Please sign in to comment.