Merge lp:~jose/charms/precise/vsftpd/fix-readme into lp:charms/vsftpd

[José Antonio Rey]

Converted README to Markdown

Converted README to Markdown

[Marco Ceppi (marcoceppi)]

LGTM +1

review: Approve

=== removed file 'README'
--- README	2012-05-03 23:38:59 +0000
+++ README	1970-01-01 00:00:00 +0000
@@ -1,42 +0,0 @@
-Juju charm vsftpd
-author: Nathan Williams <[e-mail]>
-
-1. Setup your parameters in vsftpd.yaml
-> vi vsftpd.yaml
- a list of settable parameters is available usering
-> juju get vsftpd
-or listing config.yaml
-
-2. Deploying vsftpd
-> juju bootstrap
-> juju deploy --config vsftpd.yaml vsftpd
-> juju expose vsftpd
-
-3. To find out the public address of vsftpd, browse 
-   the output of the 'juju status' command.
-
-By default, the standard ftp port, 21, is turned on,
-this is changeable through the config value: "port".
-
-When a relation is joined, a user for each juju unit
-is created and has relation parameters generated for 
-ftp_user, and ftp_passwd. The active port and server
-are also available in the relation details.
-
-The "delete_departed" config option controls whether
-to remove files belonging to users who have left the 
-relation to the ftp-server.
-
-If you decide to enable anonymous access, be aware
-that the anonymous user, while not able to upload,
-will be able to browse and download files in any 
-users home directory.
-
-Note that due to vsftpd security settings, it is not
-possible for users to upload files to their chroot'd
-home directory. Rather, each user has a folder "ftp"
-created within their chroot'd home folder which they
-can up/download to.
-
-For additional configuration options, see:
-https://help.ubuntu.com/12.04/serverguide/ftp-server.html#vsftpd-ftp-server-installation
 
=== added file 'README.md'
--- README.md	1970-01-01 00:00:00 +0000
+++ README.md	2014-04-15 22:48:00 +0000
@@ -0,0 +1,49 @@
+Juju charm vsftpd  
+Author: Nathan Williams <[e-mail]>
+
+# Usage
+
+Deploying vsftpd
+
+    juju bootstrap
+    juju deploy --config vsftpd.yaml vsftpd
+    juju expose vsftpd
+
+To find out the public address of vsftpd, browse the output of the `juju status`
+command.
+
+# Configuration
+
+Setup your parameters in vsftpd.yaml:
+
+    vi vsftpd.yaml
+
+A list of settable parameters is available using
+
+    juju get vsftpd
+
+or listing config.yaml
+
+By default, the standard ftp port, 21, is turned on, this is changeable through
+the config value: "port".
+
+The "delete_departed" config option controls whether to remove files belonging
+to users who have left the relation to the ftp-server.
+
+If you decide to enable anonymous access, be aware that the anonymous user,
+while not able to upload, will be able to browse and download files in any users
+home directory.
+
+Note that due to vsftpd security settings, it is not possible for users to
+upload files to their chroot'd home directory. Rather, each user has a folder
+"ftp" created within their chroot'd home folder which they can up/download to.
+
+# Relations
+
+When a relation is joined, a user for each juju unit is created and has relation
+parameters generated for ftp_user, and ftp_passwd. The active port and server
+are also available in the relation details.
+
+# More Info
+
+For additional configuration options, see [Ubuntu's FTP Server help page](https://help.ubuntu.com/12.04/serverguide/ftp-server.html#vsftpd-ftp-server-installation)