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

Commit 361fb6a

Browse files
obstropolosGregory Roccolambdahands
authored
updated readme for depend. (#200)
* updated readme for depend. * added disclaimer * added version update * Update README.md * updated docker shield Co-authored-by: Gregory Rocco <gregoryrocco@MBPSprueSupreme.nyc.rr.com> Co-authored-by: lambdahands <lambdahands@users.noreply.github.com>
1 parent f097583 commit 361fb6a

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
![OpenMinter header](/docs/assets/minterhead.png)
22

3-
[![](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE) [![](https://img.shields.io/badge/Docker-19.03.x-blue)](https://www.docker.com/) [![](https://img.shields.io/badge/version-v0.1-orange)](https://github.com/tqtezos/minter)
3+
[![](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE) [![](https://img.shields.io/badge/Docker-20.10.x-blue)](https://www.docker.com/) [![](https://img.shields.io/badge/version-v0.1.2-orange)](https://github.com/tqtezos/minter)
4+
5+
## Notice
6+
7+
This software is in beta. At the moment, the smart contracts
8+
that OpenMinter uses have **not** been formally audited. Please
9+
use this software at your own risk.
410

511
## OpenMinter
612

@@ -10,24 +16,30 @@ create an NFT by filling in just a few fields, create new collection
1016
contracts, see their NFTs across contracts, and enable marketplace
1117
capabilities to trade them.
1218

13-
Current version supports the following:
14-
#### 🌐 Mainnet and Delphinet (Edonet soon)
15-
#### 🎨 Image-based NFTs
16-
#### 👛 [Beacon](https://www.walletbeacon.io/) support
17-
#### ⚙️ The latest [FA2](https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-12/tzip-12.md) spec
18-
#### 🚀 [IPFS](https://ipfs.io/) support (locally and [Pinata](https://pinata.cloud/))
19+
OpenMinter supports the following networks and software components:
20+
#### 🌐 Mainnet and Delphinet networks (Edonet soon)
21+
#### 📦 Sandboxed development via [Flextesa][flextesa]
22+
#### 🎨 Creating multimedia NFTs
23+
#### 👛 Various wallets via [Beacon](https://www.walletbeacon.io/)
24+
#### 📖 Reading blockchain data via [Better Call Dev][bcdhub]
25+
#### ⚙️ The latest [FA2](https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-12/tzip-12.md) specification
26+
#### 🚀 [IPFS](https://ipfs.io/) via a local node or [Pinata](https://pinata.cloud/)
1927

2028
## Dependencies
2129

22-
- Tezos sandbox: [Flextesa][flextesa]
23-
- Blockhain indexer: [Better Call Dev Backend][bcdhub]
24-
- Database: [PostgreSQL][postgres]
25-
- InterPlanetary File System: [IPFS][ipfs]
30+
The following dependencies are required to run OpenMinter.
31+
32+
| Dependency | Version|
33+
|-|-|
34+
| [Docker][docker] | `v20.10.*` or above |
35+
| [Yarn][yarn] | `v1.22.*` or above |
2636

2737
[bcdhub]: https://github.com/baking-bad/bcdhub
2838
[flextesa]: https://gitlab.com/tezos/flextesa
2939
[postgres]: https://www.postgresql.org/
3040
[ipfs]: https://ipfs.io/
41+
[docker]: https://www.docker.com/get-started
42+
[yarn]: https://classic.yarnpkg.com/en/docs/install
3143

3244
## Usage
3345

0 commit comments

Comments
 (0)