From fd1ecdced44f68ae7845c9bda2f66044e9c1b98b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jes=C3=BAs=20G=C3=B3mez?= <jesus.gomez@fonemed.com>
Date: Wed, 14 Jul 2021 22:41:17 -0230
Subject: [PATCH] Explain project in the README

---
 README.md | 78 ++++++++++++-------------------------------------------
 deps.edn  |  3 +--
 2 files changed, 18 insertions(+), 63 deletions(-)

diff --git a/README.md b/README.md
index 70d895b..6b8057c 100644
--- a/README.md
+++ b/README.md
@@ -1,79 +1,35 @@
 # ftp-hog
 
-FIXME: my new application.
+Inspired by [MailHog](https://github.com/mailhog/MailHog) (which was
+inspired by [MailCatcher](https://mailcatcher.me/)) ftp-hog runs a
+super simple FTP server suited only for developing (NEVER USE IN
+PRODUCTION).
 
-## Installation
+Once running, it will be listening the port 2221 and serving the
+folder `/tmp`. Connect to the server as the user `anonymous` with
+empty string as the password.
 
-Download from https://github.com/jgomo3/ftp-hog
+Note: Beside all said before, this project is merly begining to be
+developed so no more functionallity is provided.
+
+I'm planning on giving options to the command line.
+
+But my main goal is still pending: I want to provide an excecutable
+exactly as MailHog does. To use MailHog you could simply download the
+executable and execute it directly: one single file. A security risk,
+but super simple. Let's see.
 
 ## Usage
 
-FIXME: explanation
 
 Run the project directly, via `:exec-fn`:
 
     $ clojure -X:run-x
     Hello, Clojure!
 
-Run the project, overriding the name to be greeted:
-
-    $ clojure -X:run-x :name '"Someone"'
-    Hello, Someone!
-
-Run the project directly, via `:main-opts` (`-m jgomo3.ftp-hog`):
-
-    $ clojure -M:run-m
-    Hello, World!
-
-Run the project, overriding the name to be greeted:
-
-    $ clojure -M:run-m Via-Main
-    Hello, Via-Main!
-
-Run the project's tests (they'll fail until you edit them):
-
-    $ clojure -X:test
-
-Build an uberjar:
-
-    $ clojure -X:uberjar
-
-This will update the generated `pom.xml` file to keep the dependencies synchronized with
-your `deps.edn` file. You can update the version (and SCM tag) information in the `pom.xml` using the
-`:version` argument:
-
-    $ clojure -X:uberjar :version '"1.2.3"'
-
-If you don't want the `pom.xml` file in your project, you can remove it, but you will
-also need to remove `:sync-pom true` from the `deps.edn` file (in the `:exec-args` for `depstar`).
-
-Run that uberjar:
-
-    $ java -jar ftp-hog.jar
-
-## Options
-
-FIXME: listing of options this app accepts.
-
-## Examples
-
-...
-
-### Bugs
-
-...
-
-### Any Other Sections
-### That You Think
-### Might be Useful
 
 ## License
 
-Copyright © 2021 Monkey
-
-_EPLv1.0 is just the default for projects generated by `clj-new`: you are not_
-_required to open source this project, nor are you required to use EPLv1.0!_
-_Feel free to remove or change the `LICENSE` file and remove or update this_
-_section of the `README.md` file!_
+Copyright © 2021 Jesús Gómez (jgomo3)
 
 Distributed under the Eclipse Public License version 1.0.
diff --git a/deps.edn b/deps.edn
index bcb9fea..415c11f 100644
--- a/deps.edn
+++ b/deps.edn
@@ -8,8 +8,7 @@
  :aliases
  {:run-m {:main-opts ["-m" "jgomo3.ftp-hog"]}
   :run-x {:ns-default jgomo3.ftp-hog
-          :exec-fn greet
-          :exec-args {:name "Clojure"}}
+          :exec-fn run}
   :test {:extra-paths ["test"]
          :extra-deps {org.clojure/test.check {:mvn/version "1.1.0"}
                       io.github.cognitect-labs/test-runner