From: Radek Czajka <radoslaw.czajka@nowoczesnapolska.org.pl>
Date: Thu, 28 Oct 2010 13:54:12 +0000 (+0200)
Subject: readme update
X-Git-Tag: 1.7~258
X-Git-Url: https://git.mdrn.pl/librarian.git/commitdiff_plain/8f76c14aae6e491816a0c07ec7fe66119dd34716?ds=sidebyside

readme update
---

diff --git a/README.md b/README.md
index ea80c92..0867419 100755
--- a/README.md
+++ b/README.md
@@ -30,14 +30,10 @@ other formats, which are more suitable for presentation.
 Currently we support:
 
  * HTML4, XHTML 1.0
- * Plain text 
- 
-In the future, we plan to support:
-
+ * Plain text
  * EPUB (XHTML based)
- * print-ready PDF 
-
-
+ * print-ready PDF
+ 
 Other features: 
 
  * extract DublinCore meta-data from documents;
@@ -48,6 +44,9 @@ Dependencies
 ------------
 
  * lxml <http://codespeak.net/lxml/>, version 2.2 or later
+ * additional PDF converter dependencies:
+   * XeTeX
+   * TeXML <http://getfo.org/texml/>
 
 
 Installation
@@ -61,14 +60,22 @@ Librarian uses standard Python distutils for packaging. After installing all the
 Usage
 ------
 
-To convert a series of file to XHTML:
+To convert a series of files to XHTML:
 
     book2html file1.xml [file2.xml ...]
 
-To convert a series of file to plain text:
+To convert a series of files to plain text:
 
     book2txt file1.xml [file2.xml ...]
 
+To convert a file to EPUB:
+
+    book2epub file.xml
+
+To convert a file to PDF:
+
+    book2pdf file.xml
+
 To extract book fragments marked as "theme":
 
     bookfragments file1.xml [file2.xml ...]