Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite README intro #1226

Merged
merged 3 commits into from
Mar 10, 2024
Merged

Rewrite README intro #1226

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49623bb
Rewrite README intro
Jaifroid Mar 6, 2024
a60a4ff
Improve text
Jaifroid Mar 9, 2024
f60a586
Minor error
Jaifroid Mar 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 11 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,19 @@

# Kiwix JS

Kiwix is an offline browser for Wikipedia, Stackexchange, Project Gutenberg, TED Talks, and hndreds of other Web resources packaged as highly compressed ZIM
archives. For full information about the open-source Kiwix project, see our main Web site: https://www.kiwix.org/.
Kiwix is your gateway for offline access to vast web resources like Wikipedia, Stackexchange, Project Gutenberg, TED Talks, and much more. These resources are
packaged as highly compressed ZIM archives available for free from Kiwix. Learn more about the open-source Kiwix project on our main [website](https://www.kiwix.org/).

Kiwix JS is an official HTML5/Javascript implementation of the Kiwix software, principally targeting browser extensions or add-ons. You
can get the extension, completely free, from the Mozilla, Chrome and Edge extension stores (see [Store links](#officially-supported-platforms) below).
There is also a version, primarily intended for use within extensions, implemented as an offline-first Progressive Web App (PWA)
at https://browser-extension.kiwix.org/current/. For the dedicated, fully featured PWA based on Kiwix JS, please see https://pwa.kiwix.org.
Kiwix JS is our official HTML5/JavaScript version, primarily designed for browser extensions. Grab our free extension from the Mozilla, Chrome, and Edge extension
stores. Check out the [Store links](#officially-supported-platforms) for more details. We also offer an offline-first Progressive Web App (PWA) version at
https://browser-extension.kiwix.org/current/. For a fully featured PWA based on Kiwix JS, visit https://pwa.kiwix.org.

To use Kiwix JS, you will need to obtain, completely free, a content archive (see [Usage](#usage)). Once you have this on your device, select it with the
file selector (Configuration page), or drag-and-drop it into the app, and start searching for article titles. No further Internet access is required to
read the archive's content. You can have the entire content of Wikipedia in your own language inside your device (including images and audiovisual content)
entirely offline. If your Internet access is expensive, intermittent, slow, unreliable, controlled or censored, you can still have offline access to this
amazing repository of knowledge, information and culture.
To get started with Kiwix JS, download a free content archive ([Usage](#usage)), select it on your device, and start exploring articles. You can access the entire
content of Wikipedia in your language, including images and audiovisual content, offline. Ideal for users with expensive, intermittent, slow, unreliable, or censored
internet access. You can even load ZIM archives shared on a USB stick or external hard drive. No internet? No problem!

The Kiwix browser works with all available content in the [OpenZIM format](https://wiki.openzim.org/wiki/OpenZIM), and has full support for [Zimit content](https://youzim.it/)
(based on the Web Archive format), both Zimit Classic and Zimit v2.0. Some content requires your browser to support Service Workers (see below).
Kiwix supports all content in the [OpenZIM format](https://wiki.openzim.org/wiki/OpenZIM), including full support for [Zimit content](https://youzim.it/) (based on
the Web Archive format), both Zimit Classic and Zimit v2.0. Note: Some content requires your browser to support Service Workers.

[![Build Status: Continuous Integration](https://github.com/kiwix/kiwix-js/workflows/CI/badge.svg?query=branch%3Amain)](https://github.com/kiwix/kiwix-js/actions?query=branch%3Amain)
[![Build Status: Release](https://github.com/kiwix/kiwix-js/workflows/Release/badge.svg?query=branch%3Amain)](https://github.com/kiwix/kiwix-js/actions?query=branch%3Amain)
Expand Down Expand Up @@ -51,7 +48,7 @@ viewable (if at all). Our sister app https://pwa.kiwix.org has some further supp
Be sure to get your ZIM archives only from a secure source, such as the official Kiwix library. This is because ZIM archives can run dynamic code in your browser. While
we do our best to sandbox the ZIM's content, a detemined malicious ZIM could remove the sandbox and redirect the iframe to, say, a phishing Web site. For this reason
we now show a Security Warning when you open a ZIM with dynamic content in ServiceWorker mode for the first time. If you do not trust the source of the ZIM, and wish to
browser static content safely, then open the ZIM first in Secure Mode before deciding whether to switch to ServiceWorker Mode.
browser static content safely, then open the ZIM first in Safe Mode before deciding whether to switch to ServiceWorker Mode.

## Compatibility

Expand Down
Loading