Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrostr committed Jun 2, 2022
1 parent 999bb6b commit 05b34f0
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# metadata
# GoData

[![Go Report Card](https://goreportcard.com/badge/github.com/piotrostr/metadata)](https://goreportcard.com/report/github.com/piotrostr/metadata)
[![codecov](https://codecov.io/gh/piotrostr/metadata/branch/master/graph/badge.svg?token=bJwa6Sf4Z7)](https://codecov.io/gh/piotrostr/metadata)
Expand Down Expand Up @@ -29,9 +29,21 @@ into a docker image of piotrostr/metadata is deployed aside a Redis image.

## Deployment

Note: The steps are user-specific since there is a number of variables like
1. The configuration file `config.json` is required for production deployments.

| field | value |
| ------------------- | --------------------------------- |
| `name` | Collection name |
| `description` | Description |
| `external_url` | GS/S3/.. URL for placholder image |
| `placeholder_image` | IPFS url for placeholder image |

2. Redis Database is also required, without it the data endpoints return
`nil`.

_Note: The steps are user-specific since there is a number of variables like
certificate issuer email etc, the steps are more of guidelines rather than
walkthrough-tutorial or local setup.
walkthrough-tutorial or local setup._

### Provision the cluster

Expand Down

0 comments on commit 05b34f0

Please sign in to comment.