Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh Greatrex authored and Josh Greatrex committed May 7, 2014
1 parent 7cc1ca7 commit b2ee893
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,36 @@ JFTP is an FTP client library that combines the two most well-known FTP librarie

The main goal of JFTP is to give you a way to create and interact with FTP connections, regardless of protocol, with relative ease.

Features
--------

JFTP has the ability to:

- Connect to FTP, FTPS and SFTP servers
- Navigate directories relative to the FTP user on the server
- Download files to a given local directory
- Upload files to a given remote directory
- List all files and directories for a given folder (or current folder) on the server


What is isn't
-------------

JFTP is ***not*** a comprehensive solution to current FTP libraries. It was designed with the sole purpose of being a small and simple to use library that gives nothing other than ***basic*** FTP functionality. The FTP client is set to always use a PASSIVE connection, and the SFTP client is set to always check on passwords over SSH keys.


Quick FTP Example
-----------------
```java
Client client = new ClientFactory().createClient(ClientType.FTP);
Client client = new ClientFactory().createClient(ClientType.FTP);
// or new FtpClient(); new SftpClient(); new FtpsClient()

client.setHost("a.host.name");
client.setPort(21);
client.setCredentials(new UserCredentials("username", "password"));

Connection connection = client.connect();
connection.setRemoteDirectory("files/todownload");
connection.changeDirectory("files/todownload");

List<FtpFile> remoteFiles = connection.listFiles();

Expand Down

0 comments on commit b2ee893

Please sign in to comment.