Update readme for changes in update/test/release process
Jessica Schilling committed
Jul 24, 2020 at 17:22 UTC
45869d3599d96251c2e6e96fbcdcb10d960036d6
1 file changed
+20
-10
README.md
+20
-10
@@ -1,37 +1,47 @@
1
# dir-index-html
2
3
-[](https://protocol.ai)
4
-[](https://ipfs.io/)
3
+[](https://protocol.ai)
4
+[](https://ipfs.io/)
5
[](https://matrix.to/#/room/#ipfs:matrix.org)
6
[](http://webchat.freenode.net/?channels=%23ipfs)
7
[](https://github.com/RichardLitt/standard-readme)
8
9
-> Directory listing HTML for go-ipfs gateways
9
+> Directory listing HTML for `go-ipfs` gateways
10
11
-This repo is not be used standalone. It's used by the gateway code in go-ipfs. It'll be merged into the gateway package, once the gateway has been extracted from go-ipfs.
11
+**NOTE:** This repo is not intended to be used as a standalone project! This code is used by the gateway code within [`go-ipfs`](https://github.com/ipfs/go-ipfs). In the long term, once the the gateway is extracted from `go-ipfs`, the code in this repo will be merged into that gateway package.
12
13
14
15
## Updating
16
17
-1. Make changes to _both_ dir-index.html and dir-index-uncat.html.
18
-2. Follow the instructions in [go-ipfs](https://github.com/ipfs/go-ipfs/tree/master/assets#updating-dir-index-html) for updating the directory index.
17
+When making updates to the directory listing page template, please note the following:
18
+
19
+1. Make your changes to the (human-friendly) source documents in the `src` directory
20
+2. Before testing or releasing, make sure to run the build script to generate a minified version in the `dist` directory:
21
+
22
+```bash
23
+> npm run build
24
+```
25
+3. To get your updates into `go-ipfs`, you'll need to do the following:
26
+ - Cut a new, appropriately versioned release of `dir-index-html` (don't forget to bump the version number in `package.json`)
27
+ - Make a PR against `go-ipfs` following [these instructions](https://github.com/ipfs/go-ipfs/tree/master/assets#updating-dir-index-html) for updating the directory index
28
29
## Testing
30
22
-1. Install [go](https://golang.org/dl/).
23
-2. Run the test server:
31
+1. Make sure you have [Go](https://golang.org/dl/) installed
32
+2. Start the test server, which lives in its own directory:
33
34
```bash
35
> cd test
36
> go run .
37
```
38
+This will listen on [`localhost:3000`](http://localhost:3000/) and reload the template every time you refresh the page.
39
30
-This will listen on `localhost:3000` and re-load the template every time you refresh the page.
40
+If you get a "no such file or directory" error upon trying `go run .`, make sure you ran `npm run build` to generate the minified artifact that the test is looking for.
41
42
## Contribute
43
34
-Feel free to join in. All welcome. A good place to start is [the issues](https://github.com/ipfs/dir-index-html/issues).
44
+Feel free to join in. All are welcome! A good place to start is to check the [issues](https://github.com/ipfs/dir-index-html/issues) for anything you find interesting.
45
46
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
47