From 936511a9feb65adacce3a43f6fe5f31b55c1298e Mon Sep 17 00:00:00 2001 From: Steven Allen Date: Tue, 21 Apr 2020 15:41:52 -0700 Subject: [PATCH] doc: document how to update Also, fix top-links. --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2f88d72ac0b..d0e2ac21ce0 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # dir-index-html -[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) -[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/) -[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) +[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai) +[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.io/) +[![Matrix](https://img.shields.io/badge/matrix-%23ipfs%3Amatrix.org-blue.svg?style=flat-square)](https://matrix.to/#/room/#ipfs:matrix.org) +[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) > Directory listing HTML for go-ipfs gateways @@ -11,6 +12,11 @@ This repo is not be used standalone. It's used by the gateway code in go-ipfs. I ![](http://gateway.ipfs.io/ipfs/Qmf82jUC9ZuoSTCNY55hyx3HmiDed3WnhFD5PC7CTSPmC2/cap.png) +## Updating + +1. Make changes to _both_ dir-index.html and dir-index-uncat.html. +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. + ## Contribute Feel free to join in. All welcome. A good place to start is [the issues](https://github.com/ipfs/dir-index-html/issues). @@ -23,4 +29,4 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c ## License -MIT \ No newline at end of file +MIT