Refresh data on "Back", allow configuration of View + border
[jvcard.git] / README.md
index 1d888ecb5f7c24e26c734a102e0ad1888a773684..0a0e5c20662d363b8f96d696e874708f2414fc78 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# jvcard
+# jVCard
 Small TUI (text mode) VCard manager (also supports abook files)
 
 ## Current version
@@ -7,14 +7,36 @@ Small TUI (text mode) VCard manager (also supports 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 create/delete a contact
 - it can be used to edit your data (currently in RAW format, field by field)
 - it can save back to file
 - English and French versions available (will look for the host language, can be forced with "--lang en")
+- remote synchronisation server (still in testing)
 
 ## TODO
 
-- ".properties" files to easily change the colours
-- correct EDIT support
 - customisation of VIEW_CONTACT
 - lot of other things
+- correct UI for new contact/new data/edit data-types
+
+## Screenshots
+
+### Navigation
+
+![Opening a directory](http://nikiroo.be/jvcard/screenshots/open-dir.png)
+![Opening a VCF/aBook card](http://nikiroo.be/jvcard/screenshots/open-vcf.png)
+
+### Contact screen
+
+![Contact screen](http://nikiroo.be/jvcard/screenshots/open-contact.png)
+
+### Image modes
+
+![Double Dithering](http://nikiroo.be/jvcard/screenshots/image-dd.png)
+![ASCII](http://nikiroo.be/jvcard/screenshots/image-ascii.png)
+![Dithering](http://nikiroo.be/jvcard/screenshots/image-dithering.png)
+![Double Resolution](http://nikiroo.be/jvcard/screenshots/image-double.png)
+
+### Edit contact screen (Work In Progress)
+
+![Edit contact WIP](http://nikiroo.be/jvcard/screenshots/edit-contact.png)