Update README.md

MFernstrom · Feb 8, 2020 · d5f8d75 · d5f8d75
1 parent 89db9e6
commit d5f8d75
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,24 @@
 # fpc-epub
 FreePascal/Lazarus unit for pulling metadata out of ePub files
+
+## Use
+1. Add `epub` to your uses clause
+2. Initialize `epub := TEpubClass.Create(nil);`
+3. Load an ePub file ` epub.load('path/to/file');`
+4. Extract data `epub.MetaData.title`
+
+## Available Metadata
+* identifier
+* title
+* language
+* creator
+* date
+* publisher
+* rights
+* subject
+* coverImage
+
+## Example application
+Source folder contains a Lazarus example project.
+
+<img src="epubInspector.PNG" />