Skip to content

Commit 3e714ac

Browse files
authored
Update App Branding (#227)
### Changes - Updates in-app logos - Updates extension icon and dev icon - Adds checkmark to the idle state to better convey the status - Updates readme with new logo - Updates Readme text - Moves app assets to `/src/assets` to match ReplayWebpage & Browsertrix project file structure - App icons are still located in `/build` and `/src/static` - The electron app icons are updated in #226 instead of this PR! Go check that one out for those! - Removes old unused brand assets --------- Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
1 parent 692dece commit 3e714ac

23 files changed

+63
-465
lines changed

README.md

+21-28
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,42 @@
1-
# ArchiveWeb.page Interactive Archiving Extension and Desktop App
1+
<h1>
2+
<div align="center">
3+
<img alt="ArchiveWebpage" src="src/assets/brand/archivewebpage-lockup-color-dynamic.svg" width="90%">
4+
</div>
5+
</h1>
26

3-
<p align="center"><img src="/assets/awp-logo.svg" width="96" height="96"></p>
7+
ArchiveWeb.page is a JavaScript based application for interactive, high-fidelity web archiving that runs directly in the browser. The system can be used as a Chrome/Chromium based browser extension and also as a standalone Electron app.
48

5-
ArchiveWeb.page is a JavaScript based system for high-fidelity web archiving directly in the browser.
6-
The system can be used as a Chrome/Chromium based browser extension and also as an Electron app.
9+
The system creates, stores, and replays high-fidelity web archives stored directly in the browser's storage (via IndexedDB).
710

8-
The system creates, stores and replays high-fidelity web archives stored directly in the browser (via IndexedDB).
11+
For more detailed info on how to use the extension and standalone app, see the [ArchiveWeb.page User Guide](https://archiveweb.page/guide).
912

10-
For more detailed info on how to use the extension (and the app when it is available), see the: [ArchiveWeb.page User Guide](https://archiveweb.page/guide)
13+
The browser extension is available on the [Chrome Web Store](https://chrome.google.com/webstore/detail/webrecorder/fpeoodllldobpkbkabpblcfaogecpndd).
1114

12-
The initial app release is available on the [Releases page](https://github.com/webrecorder/archiveweb.page/releases)
15+
Downloads for the desktop are are available on the [GitHub Releases page](https://github.com/webrecorder/archiveweb.page/releases).
1316

14-
### Architecture
17+
## Architecture
1518

1619
The extension makes use of the Chrome debugging protocol to capture and save network traffic, and extends the [ReplayWeb.page](https://github.com/webrecorder/replayweb.page) UI and the [wabac.js](https://github.com/ikreymer/wabac.js) service worker system for replay and storage.
1720

18-
The codebase for the extension and Electron app is shared, but they can be deployed in different ways.
21+
The codebase for the extension and Electron app is shared, but they can both be deployed in different ways.
1922

23+
## Building for Development
2024

21-
### Requirements Building
25+
To develop ArchiveWeb.page, install Node 12+ and Yarn.
2226

23-
To develop ArchiveWeb.page, Node 12+ and Yarn are needed.
27+
### Install the Development Extension
2428

25-
## Using the Extension
26-
27-
The production version of the extension is published to the [Chrome Web Store](https://chrome.google.com/webstore/detail/webrecorder/fpeoodllldobpkbkabpblcfaogecpndd)
28-
29-
For development, the extension can be built locally and loaded as an unpacked extension.
30-
If you want to make changes to the extension, it should be installed in this way.
29+
For development, the extension can be built locally and loaded as an unpacked extension. If you want to make changes to the extension, do the following:
3130

3231
1. Clone this repo. Run `yarn install; yarn build-dev`. (You can also run `yarn build` to build the production version but it may be harder to debug).
3332

34-
3. Open the Chrome Extensions page (chrome://extensions).
33+
3. Open the Chrome Extensions page ([chrome://extensions](chrome://extensions)).
3534

3635
4. Choose 'Load Unpacked Extension' and point to the `./dist/ext` directory in your local copy of this repo.
3736

3837
5. Click the extension icon to show the extension popup, start archiving, etc...
3938

40-
### Development Workflow
39+
### Development Workflow (Extension)
4140

4241
For development, it is recommended to use the dev build of the extension:
4342

@@ -49,10 +48,7 @@ For development, it is recommended to use the dev build of the extension:
4948

5049
4. Click the extension icon to show the extension popup, start recording, etc... The dev build of the extension will be grey to differntiate from the production version.
5150

52-
53-
## Using the Electron App (in beta)
54-
55-
The Electron app version is in beta and the latest release can be downloaded from the [Releases page](https://github.com/webrecorder/archiveweb.page/releases)
51+
### Using the Electron App
5652

5753
To run the Electron app development build:
5854

@@ -63,18 +59,15 @@ To run the Electron app development build:
6359
3. Run ``yarn run start-electron`` to start the app.
6460

6561
The Electron App version will open recording in a new window. It is is designed to support Flash, better support for IPFS sharing.
66-
However, it is still in development and may not work yet until the initial release is out.
67-
6862

69-
### Development workflow
63+
### Development workflow (Electron App)
7064

7165
After making changes, rerun ``yarn run build-dev`` and ``yarn run start-electron`` to load the app.
7266

73-
### Standalone Build
67+
## Standalone Build
7468

7569
To create a platform-specific binary, run:
7670

7771
``yarn run pack``
7872

7973
The standalone app will then be available in the `./dist/` directory.
80-

assets/awp-logo.svg

-85
This file was deleted.

assets/btrix-cloud.svg

-29
This file was deleted.

0 commit comments

Comments
 (0)