summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexis de Lattre <alexis.delattre@akretion.com>2017-09-10 22:38:13 (GMT)
committerAlexis de Lattre <alexis.delattre@akretion.com>2017-09-10 22:38:13 (GMT)
commit0c10ba7da547060bbfa49bc3c0636aa855da4d26 (patch)
treed8737d6eb38e506d909f7e3045ffb2d37e73d017
parentabadc914fa63266da99c543817c96df49d08c444 (diff)
downloadfactur-x-0c10ba7da547060bbfa49bc3c0636aa855da4d26.zip
factur-x-0c10ba7da547060bbfa49bc3c0636aa855da4d26.tar.gz
factur-x-0c10ba7da547060bbfa49bc3c0636aa855da4d26.tar.bz2
Fix and improve README
-rw-r--r--README.rst26
1 files changed, 16 insertions, 10 deletions
diff --git a/README.rst b/README.rst
index 968d691..23de165 100644
--- a/README.rst
+++ b/README.rst
@@ -15,18 +15,19 @@ Some of the features provided by this lib also work for the ZUGFeRD e-invoicing
Installation
============
-```
-sudo pip install --upgrade factur-x
-```
+.. code::
+
+ sudo pip install --upgrade factur-x
+
Usage
=====
-```
-from facturx import generate_facturx
+.. code::
+ from facturx import generate_facturx
+
+ facturx_pdf_invoice = generate_facturx(regular_pdf_invoice, facturx_xml_file)
-facturx_pdf_invoice = generate_facturx(regular_pdf_invoice, facturx_xml_file)
-```
To have more examples, look at the source code of the command line tools located in the *bin* subdirectory.
@@ -35,12 +36,17 @@ Command line tools
Several command line tools are provided with this lib:
-* facturx-pdfgen: generate a Factur-X PDF invoice from a regular PDF invoice and an XML file
-* facturx-pdfextractxml: extract the Factur-X XML file from a Factur-X PDF invoice
-* facturx-xmlcheck: check a Factur-X XML file against the official Factur-X XML Schema Definition
+* **facturx-pdfgen**: generate a Factur-X PDF invoice from a regular PDF invoice and an XML file
+* **facturx-pdfextractxml**: extract the Factur-X XML file from a Factur-X PDF invoice
+* **facturx-xmlcheck**: check a Factur-X XML file against the official Factur-X XML Schema Definition
All these commande line tools have a **-h** option that explains how to use them and shows all the available options.
+Licence
+=======
+
+This library is published under the BSD licence (same licence as `PyPDF2 <http://mstamy2.github.io/PyPDF2/>`_ on which this lib depends).
+
Contributors
============