Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
mkiol committed Nov 24, 2018
1 parent 15a8b12 commit e3f5bb5
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Zimpedia

Offline reader for Wikipedia and other Wiki projects.
Offline reader for Wikipedia and other Wiki-like projects.

## Description
Zimpedia provides localhost HTTP server that serves content of
local [ZIM](https://en.wikipedia.org/wiki/ZIM_%28file_format%29) repository.
Zimpedia is a [ZIM](https://en.wikipedia.org/wiki/ZIM_%28file_format%29) repository offline reader.
The ZIM is an open file format that stores Wiki content for offline usage.
Its primary focus is on the contents of Wikipedia but also other Wiki projects
like Wikivoyage are supported.

Zimpedia is a Sailfish OS application.

## Downloads
Binary packages for Jolla phone and Jolla tablet can be downloaded
from [OpenRepos](https://openrepos.net/content/mkiol/zimpedia) and Jolla Store.

Package for BlackBerry 10 devices can be downloaded
Old package (not supported) for BlackBerry 10 devices can be downloaded
from [BlackBerry World](https://appworld.blackberry.com/webstore/content/59988411).

## ZIM repositories downloads
Expand All @@ -24,17 +25,17 @@ from [Kiwix project](http://www.kiwix.org/wiki/Content_in_all_languages)
website.

## Translations
If you would like to contribute to the project by doing translation, feel free to make pull request
with new [translation file](https://github.com/mkiol/Zimpedia/tree/master/sailfish/translations) or
add translation using [Transifex](https://www.transifex.com/mkiol/zimpedia/) service.

## Third-party components
Zimpedia uses and completely relies on following third-party open source
components:
If you would like to contribute to the project by doing translation, feel free to:
* make pull request with new [translation file](https://github.com/mkiol/Zimpedia/tree/master/sailfish/translations), or
* add translation using [Transifex](https://www.transifex.com/mkiol/zimpedia/) service, or
* just send finished translation file to Zimpedia's support email.

## Libraries
Zimpedia uses and completely relies on following open source
libraries:
* [QHTTPServer](https://github.com/nikhilm/qhttpserver) by Nikhil Marathe
* [ZimLib](http://www.openzim.org/wiki/Zimlib) by openZIM project team

---------------

Zimpedia is distributed under
## License
Zimpedia is developed as an open source project under
[Mozilla Public License Version 2.0](https://www.mozilla.org/MPL/2.0/).

0 comments on commit e3f5bb5

Please sign in to comment.