Skip to content

amrangry/ePubReader

Repository files navigation

ePubReader

reader for epub file POC for iOS using readium

Table of Contents

Technology

Readium Readium Swift Toolkit

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Supported OS & SDK Versions

  • Supported build target - iOS 13.0 and later (Xcode 14.x)

Versioning

this project adheres to Semantic versioning

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make incompatible API changes,
  • MINOR version when you add functionality in a backwards compatible manner, and
  • PATCH version when you make backwards compatible bug fixes.

TODO

  • Remove library screen
  • Change font
  • Fix scroll option
  • Fix scroll option to be vertical or horizontal only

Contributing

We alway welcome your contributions 👏

Development

  1. Fork (https://github.com/amrangry/ePubReader) 🎉
  2. Create a feature branch ☕
  3. Run test suite with the $ make test command and confirm that it passes ⚡
  4. Commit your changes 📝
  5. Rebase your local changes against the master branch 💡
  6. Create new Pull Request 💌

Bugs, feature requests and comments are more than welcome in the issues.

Feedback

I would like to make ePubReader a better Project.
The goal is to be able to use in various projects.

Therefore, your feedback is very useful.
I am very happy to tell you your opinions on Issues and PR ❤️

Author

Amr Ahmed Elghadban

Amr Ahmed Elghadban (AmrAngry)

Email WhatsApp LinkedIn

GitHub StackOverflow

Twitter (formerly Twitter) Facebook Website

Contributing 🤘

All your feedback and help to improve this project is very welcome. Please create issues for your bugs, ideas & enhancement requests, or better yet, contribute directly by creating a PR. 😎

When reporting an issue, please add a detailed instruction, and if possible a code snippet or test that can be used as a reproducer of your problem. 💥

When creating a pull request, please adhere to the current coding style where possible, and create tests with your code so it keeps providing an awesome test coverage level 💪

License

MIT License. Distributed under MIT License. Copyright 2025 Amr Elghadban

About

reader for epub file POC for iOS

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published