Skip to content

Commit 5f38e3c

Browse files
committed
Update Readme
1 parent 99984e6 commit 5f38e3c

4 files changed

Lines changed: 76 additions & 19 deletions

File tree

CC-TB.png

0 Bytes
Loading

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Contributing to CC NFT-ToolBox
2+
3+
Do you want to join with us to improve this tools. That's a great news to us.
4+
We are hurry to here from you please drop a mail to dewmal@syigen.com

README.MD

Lines changed: 53 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,46 @@
1-
## CRYPT-CHEF NFT - All in one NFT Toolbox
2-
1+
## CRYPT-CHEF NFT - All in one Toolbox
2+
### CC NFT - TOOLBOX
33
![CRYPT-CHEF TOOL BOX](CC-TB.png)
44

5+
**CC - NFT-TOOLBOX** is a tool for manage your all nft related tasks without worrying devlopment
6+
7+
Thier are lot of task in nft world as a designer need a help from developers. such as
58

9+
1. Generate Collection from art work
10+
2. Publish your collection
11+
3. Mint your collection
612

13+
We are ready to provide support for all of these tasks
14+
First of all we are happy to introduce our **Brand New NFT ToolBox** core with support of
715

8-
- [CRYPT-CHEF NFT - All in one NFT Toolbox](#crypt-chef-nft---all-in-one-nft-toolbox)
16+
Please check our Project [road map](ROADMAP.MD) for more details.
17+
18+
Table of content
19+
----------------
20+
- [CRYPT-CHEF NFT - All in one Toolbox](#crypt-chef-nft---all-in-one--toolbox)
21+
- [CC NFT - TOOLBOX](#cc-nft---toolbox)
22+
- [Table of content](#table-of-content)
923
- [Features](#features)
1024
- [How to use](#how-to-use)
1125
- [1. Initialize Project](#1-initialize-project)
1226
- [2. Export Collection](#2-export-collection)
1327
- [3. View Collection Summary](#3-view-collection-summary)
1428
- [4. View Rarity Table](#4-view-rarity-table)
15-
- [Support Configurations](#support-configurations)
16-
17-
18-
19-
## Features
29+
- [Support Configurations](#support-configurations)
30+
- [1. Layer Order](#1-layer-order)
31+
- [2. Incompatible Layers](#2-incompatible-layers)
32+
- [3. Forced Combined Layers](#3-forced-combined-layers)
33+
- [4. Project Description](#4-project-description)
34+
- [5. Number of unique items](#5-number-of-unique-items)
35+
- [6. Extra Attributes](#6-extra-attributes)
36+
- [7. Extra Meta Data](#7-extra-meta-data)
37+
- [8. Hash Image](#8-hash-image)
38+
- [9. Base URI](#9-base-uri)
39+
- [Contributing](#contributing)
40+
41+
42+
Features
43+
--------
2044

2145
- **Support to have multiple projects**
2246
- Manage multiple project without changing code
@@ -50,7 +74,8 @@
5074

5175

5276

53-
## How to use
77+
How to use
78+
----------
5479

5580

5681
##### 1. Initialize Project
@@ -105,9 +130,10 @@ nftgen.exe project rarity
105130
| ------ | --------------- | ------------ |
106131
| path | Excution folder | Project path |
107132

108-
### Support Configurations
133+
Support Configurations
134+
----------------------
109135

110-
1. Layer Order
136+
##### 1. Layer Order
111137
```json
112138
"layerConfigurations":[
113139
{
@@ -122,7 +148,7 @@ nftgen.exe project rarity
122148
* We can have multiple layerConfiguration in here and layerConfiguration can have one layerOrder
123149

124150

125-
2. Incompatible Layers
151+
##### 2. Incompatible Layers
126152
```json
127153
"incompatible": {
128154
"<TraiType/LayerName>*<TraitName>": [
@@ -145,7 +171,7 @@ nftgen.exe project rarity
145171
```
146172
In here you need **Sunglass*1-01.png** not combined with [**Beard*1-01.png**, **Mouth*1-01.png**]
147173

148-
3. Forced Combined Layers
174+
##### 3. Forced Combined Layers
149175
```json
150176
"forcedCombinations": {
151177
"<TraiType/LayerName>*<TraitName>": [
@@ -167,17 +193,17 @@ nftgen.exe project rarity
167193
In here you need **Sunglass*1-01.png** with **Hat*2-01.png** and **Pipe*1-01.png**
168194

169195

170-
4. Project Description
196+
##### 4. Project Description
171197
```json
172198
"description": "<text>",
173199
```
174-
5. Number of unique items
200+
##### 5. Number of unique items
175201
```json
176202
"uniqueDnaTorrance":<int>
177203
```
178204
Using this variable system will generate unique number of assets without repeating
179205

180-
6. Extra Attributes
206+
##### 6. Extra Attributes
181207
```json
182208
"extraAttributes": [{
183209
"<name-1>": "<text>",
@@ -188,7 +214,7 @@ nftgen.exe project rarity
188214
These extra data can append with original asset metadata attributes
189215

190216

191-
7. Extra Meta Data
217+
##### 7. Extra Meta Data
192218
```json
193219
"extraMetadata": {
194220
"testName": "testValue"
@@ -197,18 +223,26 @@ nftgen.exe project rarity
197223

198224
These extra meta data append to the original asset metadata
199225

200-
8. Hash Image
226+
##### 8. Hash Image
201227
```json
202228
"hashImages": false,
203229
```
204230

205231
Image need uniques hash value you have to make this true
206232

207-
9. Base URI
233+
##### 9. Base URI
208234

209235
```json
210236
"baseURI": "<baseurl>"
211237
```
212238
In here system update all meta data with your collection baseURI
213239

214240

241+
Contributing
242+
------------
243+
244+
Want to help develop/improve CC NFT-TOOLBOX? Check out our
245+
[contributing documentation](CONTRIBUTING.md).
246+
247+
If you find an issue, please report it on the
248+
[issue tracker](https://github.com/CryptChef/nft-toolbox/issues).

ROADMAP.MD

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## CC NFT-TOOLBOX Road MAP
2+
3+
### Phase 1 - Generate Collection from art work
4+
5+
- [X] Create project
6+
- [X] Generate collection
7+
- [X] View rarity table
8+
- [X] View summary detail
9+
- [x] Support for ETH base metadata
10+
- [ ] Support for multiple network (Solana, Cardano)
11+
- [ ] Upload your collection into cloud
12+
13+
### Phase 2 - Publish your collection
14+
15+
You can upload your collection into any market place
16+
17+
### Phase 2 - Mint your collection
18+
19+
You can mint your collection and monitor collection stats

0 commit comments

Comments
 (0)