Skip to content

Commit a127aba

Browse files
committed
Format markdown
1 parent 068049c commit a127aba

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# Orcfax Archive Viewer
22

3-
Orcfax Archive Viewer is a Svelte app that compiles everything needed to explore a single Orcfax Fact Statement archive from Arweave into a single static `index.html` file that is intended to be used locally and offline.
3+
Orcfax Archive Viewer is a Svelte app that compiles everything needed to explore
4+
a single Orcfax Fact Statement archive from Arweave into a single static
5+
`index.html` file that is intended to be used locally and offline.
46

5-
The compiled static `index.html` file is packaged along with the [Orcfax Explorer](https://github.com/orcfax/explorer.orcfax.io) as a static asset so that it can be downloaded and packaged along with a full Fact Statement archive folder which is fetched from Arweave.
7+
The compiled static `index.html` file is packaged along with the
8+
[Orcfax Explorer](https://github.com/orcfax/explorer.orcfax.io) as a static
9+
asset so that it can be downloaded and packaged along with a full Fact Statement
10+
archive folder which is fetched from Arweave.
611

7-
The viewer does not access the folder of archived files directly, instead, on download from the Explorer, a JSON representation of the archive's contents are injected into a global window variable so it can be used internally.
12+
The viewer does not access the folder of archived files directly, instead, on
13+
download from the Explorer, a JSON representation of the archive's contents are
14+
injected into a global window variable so it can be used internally.
815

916
An example JSON file is included in the repo for local development purposes.
1017

@@ -20,9 +27,14 @@ pnpm i
2027

2128
## Building
2229

23-
To run the viewer with local test data, copy the contents of `example-archive.json` and paste it in place of `'DATA_PLACEHOLDER'` (NB. replace the single-quotation marks as well) at the bottom of `/index.html` located at the root of this repository.
30+
To run the viewer with local test data, copy the contents of
31+
`example-archive.json` and paste it in place of `'DATA_PLACEHOLDER'` (NB.
32+
replace the single-quotation marks as well) at the bottom of `/index.html`
33+
located at the root of this repository.
2434

25-
Once you have replaced the `'DATA_PLACEHOLDER'` (including quotes) it is recommended to run formatting and linting first. This will prettify the source data.
35+
Once you have replaced the `'DATA_PLACEHOLDER'` (including quotes) it is
36+
recommended to run formatting and linting first. This will prettify the source
37+
data.
2638

2739
```bash
2840
pnpm run format
@@ -45,4 +57,6 @@ Start a development server with:
4557
pnpm run dev
4658
```
4759

48-
The local archive will be visible at the server location and port on your localhost, e.g. `http://<localhost-ip>:<port>/`. Alternatively, open the `build/index.html` file in your choice of web-browser.
60+
The local archive will be visible at the server location and port on your
61+
localhost, e.g. `http://<localhost-ip>:<port>/`. Alternatively, open the
62+
`build/index.html` file in your choice of web-browser.

0 commit comments

Comments
 (0)