From: Niki <niki@nikiroo.be>
Date: Tue, 1 Mar 2016 17:25:09 +0000 (+0100)
Subject: Create README.md
X-Git-Tag: v1.0-beta1~3
X-Git-Url: http://git.nikiroo.be/?a=commitdiff_plain;h=f81b2ad963b57dcdcac9d694fdd584a7845806c3;hp=f82bad11bbabc89805a5a8000f59a3b1df3e5c3d;p=jvcard.git

Create README.md
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..04850f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# jvcard
+Small TUI (text mode) VCard manager (also supports abook files)
+
+## Current version
+
+- it can open VCF and ABOOK files
+- it can create a Swing terminal or use a real terminal (try "--help") using Lanterna 3 (which can be found here on GitHub, too)
+- it will list all the contacts of the file you select
+- it will show more detailed informations about a selected contact, including an ASCII art representation of their photo if any
+- it can delete a contact
+- it can be used to edit your data (currently in RAW format, field by field)
+- it can save back to file
+
+## TODO
+
+- ".properties" files to easily change the colours
+- correct EDIT support
+- customisation of VIEW_CONTACT
+- French translation to check if everything is translatable
+- lot of other things