Skip to content

Commit 341c4e9

Browse files
authored
docs: update description and readme (#165)
1 parent df585c1 commit 341c4e9

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@
88

99
## Background
1010

11-
This repo is responsible for standalone tool that lives at https://explore.ipld.io
11+
This repo is responsible for standalone tool that lives at https://explore.ipld.io
1212
Component code lives in a separate repo at [ipld-explorer-components](https://github.com/ipfs/ipld-explorer-components)
1313

14-
The app will use HTTP API via [`ipfs-http-client`](https://www.npmjs.com/package/ipfs-http-client) provided by locally running IPFS node with correct CORS headers set up, and fallback to using [js-ipfs](https://github.com/ipfs/js-ipfs) otherwise.
14+
The ipld-explorer-components library uses [`@helia/http`](https://www.npmjs.com/package/@helia/http) to query any local IPFS node, and the network, for content. See https://github.com/ipfs/ipld-explorer-components/blob/8718cd07cd27a82fdeaa25b92c6809ba3cec489c/src/providers/helia.tsx and https://github.com/ipfs/ipld-explorer-components/blob/8718cd07cd27a82fdeaa25b92c6809ba3cec489c/src/lib/init-helia.ts#L23 for specifics.
1515

16-
The app is built with [`create-react-app`](https://github.com/facebook/create-react-app). Please read the [docs](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#table-of-contents).
16+
The app is built with [`Vite`](https://vitejs.dev/). Please read the [docs](https://vitejs.dev/guide/).
1717

1818

1919
## Install
2020

21-
With `node` > 10 (but < 12) and `npm` @ 6+ installed, run
21+
With `node` and `npm` installed, run
2222

2323
```js
2424
npm install
2525
```
2626

2727
## Usage
2828

29-
When developing you can run the [dev server](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-start), the [unit tests](https://facebook.github.io/jest/), and the [storybook](https://storybook.js.org/) component viewer and see the results of your changes as you save files.
29+
When developing you can run the [dev server](https://vitejs.dev/guide/cli.html#dev), the [unit tests](https://vitest.dev/), and the [storybook](https://storybook.js.org/) component viewer and see the results of your changes as you save files.
3030

3131
In separate shells run the following:
3232

@@ -36,7 +36,7 @@ npm test
3636
```
3737

3838
```sh
39-
# Run the dev server @ http://localhost:3000
39+
# Run the dev server @ http://localhost:5173
4040
npm start
4141
```
4242

@@ -71,11 +71,11 @@ The following command will run the app tests, watch source files and re-run the
7171
npm test
7272
```
7373

74-
The uses Jest to run the isolated unit tests. Unit test files are located next to the component they test and have the same file name, but with the extension `.test.js`
74+
The app uses Vitest to run the isolated unit tests. Unit test files are located next to the component they test and have the same file name, but with the extension `.test.js`
7575

7676
### Linting
7777

78-
The following command will perform [`standard`](https://standardjs.com/) linting on the code:
78+
The following command will perform linting on the code using [`aegir`](https://github.com/ipfs/aegir):
7979

8080
```sh
8181
npm run lint

0 commit comments

Comments
 (0)