Skip to content
This repository was archived by the owner on Jul 31, 2023. It is now read-only.

Commit 1a20522

Browse files
author
Philip Diaz
committed
doc: Fix README typos, clarify Pinata usage
1 parent 44775e5 commit 1a20522

File tree

1 file changed

+23
-18
lines changed

1 file changed

+23
-18
lines changed

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@ $ yarn install
4040
```
4141

4242
The installation process will fetch toplevel NPM dependences and build
43-
the `minter-ui-dev` and `minter-api-dev` Docker images. Subsequent runs of
44-
`yarn install` will rebuild these images without checking for cached versions.
43+
the `minter-ui-dev` and `minter-api-dev` Docker images.
4544

4645
### Configuration
4746

@@ -89,16 +88,16 @@ administrator during contract origination:
8988
```
9089
9190
> **Note:** Since sandbox keys don't represent sensitive accounts, the `config/`
92-
> folder includes default configurations with `admin` wallets. To configure Minter
93-
> for the `testnet` or `mainnet` networks, update the definitions in
91+
> folder includes default configurations with `admin` wallets. To configure
92+
> OpenMinter for the `testnet` or `mainnet` networks, update the definitions in
9493
> `config/minter.<network>.example.json` and copy it to the proper path for the
95-
> application to read it. For:
94+
> application to read it. For example:
9695
>
9796
> `cp config/minter.mainnet.example.json config/minter.mainnet.json`
9897
99-
If the `contracts` key or its children `nftFaucet` or `nftFactory` keys are not
100-
specified, these contracts will be originated and their addresses saved in the
101-
configuration file when starting the Minter devleopment environment.
98+
If the `contracts` key or its child `nftFaucet` keys is not specified, a new
99+
contract will be originated and its addresses saved in the configuration file
100+
when starting the OpenMinter development environment.
102101
103102
#### Pinata
104103
@@ -107,21 +106,27 @@ keys in order to direct all file uploads through their service. This allows for
107106
ease of use while working with IPFS as running OpenMinter without Pinata will
108107
rely on using and maintaining a local IPFS node.
109108
110-
> **Note:** The example `testnet` and `mainnet` configurations in the `config/`
111-
> folder have placeholder Pinata API keys. If you want to use OpenMinter on
112-
> these networks without Pinata, remove the `pinata` key from the configuration.
109+
> ⚠️ **Note:** The example `testnet` and `mainnet` configurations in the
110+
`config/` folder have placeholder Pinata API keys as it's the most robust way
111+
> to easily persist data on IPFS. Using OpenMinter on these networks without
112+
> Pinata may cause data loss as the NFT metadata and artifacts must be resolved
113+
> over IPFS. If you want to use OpenMinter on these networks without Pinata,
114+
> remove the `pinata` key from the configuration, but be aware that this entails
115+
> running and maintaining your own IPFS gateway in order for your NFT data token
116+
> remain accessible.
117+
113118
114119
[pinata]: https://pinata.cloud
115120
116121
### Starting and Stopping
117122
118-
During its start process, Minter will create or update Docker services for its
119-
specified environment and also bootstrap the required contracts if their
123+
During its start process, OpenMinter will create or update Docker services for
124+
its specified environment and also bootstrap the required contracts if their
120125
addresses are not defined in the environment's configuration file.
121126
122127
#### Sandbox
123128
124-
To start Minter on a `sandbox` network, run:
129+
To start Minter in a `sandbox` network, run:
125130
126131
```sh
127132
$ yarn start:sandbox
@@ -142,7 +147,7 @@ $ yarn stop:sandbox
142147
143148
#### Testnet
144149
145-
To start Minter on a `testnet` network, run:
150+
To start Minter on the `testnet` network, run:
146151
147152
```sh
148153
$ yarn start:testnet
@@ -161,7 +166,7 @@ $ yarn stop:testnet
161166
162167
#### Mainnet
163168
164-
To start Minter on a `mainnet` network, run:
169+
To start Minter on the `mainnet` network, run:
165170
166171
```sh
167172
$ yarn start:mainnet
@@ -229,7 +234,7 @@ $ yarn log:api --since 5m
229234
230235
### Editor Environments
231236
232-
Docker development images are set up to reload server and web ui on source code
237+
Docker development images are set up to reload server and web UI on source code
233238
changes.
234239
235240
To setup this project for an IDE, you will want to install NPM dependencies
@@ -263,7 +268,7 @@ $ svc-restart(){docker service scale minter-dev-sandbox_$1=0 && docker service s
263268

264269
## Release Builds (WIP)
265270

266-
Development ui and api server builds can be swapped out for release builds:
271+
Development UI and API server builds can be swapped out for release builds:
267272

268273
```sh
269274
$ bin/build-release-images

0 commit comments

Comments
 (0)