<commit_before>SimpleEpubReader
================

A Basic epub reader. Showcases some simple parsing of the file format.
<commit_msg>Added some information in README.md<commit_after>
# SimpleEpubReader

SimpleEpubReader is the bare minimum functionality needed in order to work with the EPUB file format. It showcases some fundamental implementation details of conforming to the EPUB specification described by the International [Digital Publishing Forum][EPUB spec].

## Features

1. Parsing EPUB files
 1. Opening zip archives
 1. Reading data from zip file without extracting the whole archive
 1. Processing EPUB metadata
 1. Processing the `container.xml`
 1. Processing the root file
 1. Processing Table of contents
 1. Showing the table of contents in a table view
 1. Displaying the EPUB contents in a UIPageViewController
 1. Loading web page resources located inside the zip archive via a custom NSURLProtocol subclass
 1. Bookmarks support (comming soon...)

[EPUB spec]: http://idpf.org/epub

{'fraction_non_alphanumeric': 0.06069651741293532, 'fraction_numerical': 0.010945273631840797, 'mean_word_length': 4.68361581920904, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 1}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3644559', 'n_tokens_mistral': 267, 'n_tokens_neox': 250, 'n_words': 134}