X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=README.md;h=6b5c5f941c65fddbcc052a0742a196aee9b648bc;hp=063c248bc1d06ca0bd2867970437650117735ed0;hb=d649ced99f929e1fcf2421a2357f5fdb8d2fcfe1;hpb=adc71d366322224b61ffc3a40f2881e5b809d343

diff --git a/README.md b/README.md
index 063c248..6b5c5f9 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,17 @@
 
 Fanfix is a small Java program that can download stories from some supported websites and render them offline.
 
+(If you are interested in the recent changes, please check the [Changelog](changelog.md).)
+
 ![Main GUI](screenshots/fanfix.png?raw=true "Main GUI")
 
-It will convert from a (supported) URL to an .epub file for stories or a .cbz file for comics (a few other output types are also available, like Plain Text or LaTeX).
+It will convert from a (supported) URL to an .epub file for stories or a .cbz file for comics (a few other output types are also available, like Plain Text, LaTeX, HTML...).
 
 To help organize your stories, it can also work as a local library.
 
 In this mode, you can:
-- Import a story from its URL (or even another file)
-- Export a story to a file (.epub or .cbz)
+- Import a story from its URL (or just from a file)
+- Export a story to a file (in any of the supported output types)
 - Display a story from the local library in text format in the console
 - Display a story from the local library graphically **by calling a native program to handle it** (though Fanfix can automatically process it into HTML so any browser can open it)
 
@@ -34,12 +36,13 @@ We support a few file types for local story conversion (both as input and as out
   - a cover image may be present with the same filename as the story, but a .png, .jpeg or .jpg extension
 - info_text: contains the same information as the text format, but with a companion .info file to store some metadata (the .info file is supposed to be created by Fanfix or compatible with it)
 - cbz: .cbz (collection of images) files, preferably created with Fanfix (but any .cbz file is supported, though without most of Fanfix metadata, obviously)
+- html: HTML files that you can open with any browser; note that it will create a directory structure with ```index.html``` being the file you need to open (or select if you want to convert it into something else) -- we only support importing HTML files created by Fanfix or compatible
 
 ## Supported platforms
 
 Any platform with at lest Java 1.6 on it should be ok.
 
-It has only been tested on Linux and Windows for now, but feel free to inform me if you try it on another system.
+It has been tested on Linux, MacOS X and Windows for now, but feel free to inform me if you try it on another system.
 
 If you have any problems to compile it with a supported Java version (1.5 won't work, but you may try to cross-compile; 1.6 and 1.8 have been tested and work), please contact me.
 
@@ -56,7 +59,7 @@ The following arguments are also allowed:
 - ```--read [id] ([chapter number])```: read the given story denoted by ID from the library
 - ```--read-url [URL] ([chapter number])```: convert on the fly and read the story denoted by ID, without saving it
 - ```--list```: list the stories present in the library and their associated IDs
-- ```--set-reader [reader type]```: set the reader type to CLI or LOCAL for this command
+- ```--set-reader [reader type]```: set the reader type to CLI or LOCAL for this command (must be the first option)
 - ```--help```: display the available options
 
 ### Environment variables
@@ -89,8 +92,9 @@ Currently missing, but either in progress or planned:
   - [x] Make one
   - [x] Make it run when no args passed
   - [x] Fix the UI, it is ugly
-  - [ ] Work on the UI thread is BAD
-  - [ ] Allow export
+  - [x] Work on the UI thread is BAD
+  - [x] Allow export
+  - [x] Allow delete/refresh
   - [ ] Show a list of types
     - [x] ..in the menu
     - [ ] ..as a screen view
@@ -100,9 +104,15 @@ Currently missing, but either in progress or planned:
 - [ ] Translations
   - [x] i18n system in place
   - [x] Make use of it
-  - [x] Use it for all user output (some WIP remains)
+  - [x] Use it for most user ouput
+  - [ ] Use it for all user output
   - [ ] French translation
-- [ ] Allow lauching a custom application instead of Desktop.start ?
+- [x] Allow lauching a custom application instead of Desktop.start ?
   - [ ] Make a wrapper for firefox to create a new, empty profile ?
-- [ ] Install a mechanism to handle stories import progress update
+- [x] Install a mechanism to handle stories import/export progress update
+  - [x] Progress system
+  - [x] in support classes (import)
+  - [x] in output classes (export)
+  - [x] CLI usage of such
+  - [x] GUI usage of such