Update README.md

merge-requests/23/head
Michał "rysiek" Woźniak 2022-12-16 13:07:41 +00:00
rodzic 24cbec237c
commit a7988e3e0a
1 zmienionych plików z 7 dodań i 7 usunięć

Wyświetl plik

@ -7,6 +7,8 @@ Ideally, users should not need to install any special software nor change any se
**Project website: https://resilient.is
Documentation: https://resilient.is/docs**
A [Quickstart Guide is available](https://resilient.is/docs/QUICKSTART/), along with [Frequently Asked Questions](https://resilient.is/docs/FAQ/). These are good places to start. You can also read a more in-depth overview of LibResilient [here](https://resilient.is/docs/ARCHITECTURE/). And [here](https://resilient.is/docs/PHILOSOPHY/) is a document describing the philosophy influencing project goals and relevant technical decisions.
## Current status
LibResilient is currently considered *beta*: the code works, and the API is mostly stable, but it has not yet been deployed in production on a reasonably high-traffic site and would benefit from real-world testing. During development it has been tested on Firefox, Chromium and Chrome on desktop, as well as Firefox for mobile on Android, but it should work in any browser implementing the Service Worker API.
@ -21,13 +23,6 @@ On the other hand, visitors have at their disposal many tools that allow them to
LibResilient explores the possibility of solving this conundrum in a way that would not require website visitors to install any special software or change any settings; the only things that are needed are a modern Web browser and the ability to visit a website once, so that the JavaScript ServiceWorker kicks in.
You can read more in-depth overview of LibResilient [here](https://resilient.is/docs/ARCHITECTURE/). And [here](https://resilient.is/docs/PHILOSOPHY/) is a document describing the philosophy influencing project goals and relevant technical decisions.
## Related developments
- https://ipfs.io/ipfs/QmNhFJjGcMPqpuYfxL62VVB9528NXqDNMFXiqN5bgFYiZ1/its-time-for-the-permanent-web.html
- https://blog.archive.org/2015/02/11/locking-the-web-open-a-call-for-a-distributed-web/
## Development
To test the service worker locally you will need a minimal web server. Probably the simplest way is to start one directly in the project directory, either using Python:
@ -57,3 +52,8 @@ If you don't have NodeJS on your machine, you can run them by using Docker (also
```bash
docker run -ti --rm --volume "${PWD}:/code" node:17.0 /bin/bash -c 'cd /code && npx jest ./__tests__/'
```
## Related developments
- https://ipfs.io/ipfs/QmNhFJjGcMPqpuYfxL62VVB9528NXqDNMFXiqN5bgFYiZ1/its-time-for-the-permanent-web.html
- https://blog.archive.org/2015/02/11/locking-the-web-open-a-call-for-a-distributed-web/