Skip to content

Commit

Permalink
readme tweaks for 2.20
Browse files Browse the repository at this point in the history
  • Loading branch information
ikreymer committed Oct 17, 2024
1 parent 4241161 commit 5b7af58
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ _service worker based web archive replay_
**wabac.js** provides a full web archive replay system, or 'wayback machine', using
[Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API/Using_Service_Workers)

**wabac.js** is a core part of <img src="https://replayweb.page/assets/logo.svg" width="24" height="24"> [ReplayWeb.page](https://replayweb.page).
**wabac.js** is a core part of <img src="https://raw.githubusercontent.com/webrecorder/replayweb.page/refs/heads/main/favicons/icon-192.png" width="24" height="24"> [ReplayWeb.page](https://replayweb.page).

With 2.20.0 release, wabac.js is actually fully TypeScript based.

This library provides the 'server-side' portion for web archive replay, and an API for managing web archive collections,
and is designed to be run as service worker (or web worker). The system handles URL rewriting and preparing web archive
Expand All @@ -22,11 +24,20 @@ Using the ReplayWeb.page is only one way to use wabac.js. Additional ways to use

- [Live Proxy](./examples/live-proxy) - an example of using wabac.js to render a live, rewritten proxy of other web pages, with custom scripts injected into each page. This can be used to provide an annotation viewer to live web pages.

## API Documentation
## API

The wabac.js includes an internal API provides for loading web archives and getting information about a web archive collections.
Additional documentation is still needed.


## Usage as Library

The library provides two general purpose exports:

`import * from @webrecorder/wabac` - Provides exports for rewriting and WACZ reading. Designed for any JS environment. See [index.ts](src/index.ts) for more details.

The API provides all functionality for loading web archives and getting information about a web archive collections.
`import * from @webrecorder/wabac/swlib` - Provides exports for extending wabac.js in a service worker. Designed to be used in a service worker or web worker environment. See [swlib.ts](src/swlib.ts) for more details.

_Documentation coming soon!_

## Old Version

Expand Down

0 comments on commit 5b7af58

Please sign in to comment.