Skip to content

Commit 7fa428b

Browse files
committedJun 18, 2024
Add more info to README.md, update package info
1 parent b703023 commit 7fa428b

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed
 

‎README.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
11
# Voxelite JSON Merger
22

3-
GitHub Action to merge [Voxelite](https://github.com/voxelite)'s `block.json` (main JSON) with all JSONs in `block` directory.
3+
GitHub Action to merge [Voxelite](https://voxelite.net)'s `block.json` (main JSON) with all JSONs in `block` directory.
44
The same can be done for items, entities...
55

6+
This is intended to allow two different approaches of object management (all objects of same type in single file and one file per object) to be used at the same time.
7+
It also minimizes the JSON by removing unimportant new lines and whitespaces (harder to read for humans but still valid JSON).
8+
69
## Inputs
710

811
### `in-file`
912

10-
Path to your `block.json` (or equivalent).
13+
Path to your multi-object file - `block.json` (or equivalent for other object types).
1114

1215
This is your main file with data.
1316
Inside the file you should have a JSON Object with keys for codenames and their values an object with all the configuration.
1417

18+
Leave empty when you don't have multi-object file.
19+
1520
### `in-directory`
1621

17-
Path to your directory containing all object files.
18-
Inside each object (like a block) is represented by a single JSON file.
22+
Path to your directory containing all single-object files.
23+
Inside each JSON file is a single object (like a block or item).
24+
1925
Name of the file is used as the object's name and inside is a JSON Object with all the configuration.
2026

27+
Leave empty when you don't have directory of single-object files.
28+
2129
### `out-file`
2230

2331
**Required**

‎package.json

+16-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
11
{
22
"name": "json-merge",
3-
"version": "1.0.0",
4-
"description": "",
3+
"version": "1.1.0",
4+
"description": "Merges multi-object JSON with multiple single-object JSONs",
55
"main": "index.js",
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1"
88
},
99
"keywords": [],
10-
"author": "",
10+
"author": "Abit Gray",
1111
"license": "ISC",
1212
"dependencies": {
1313
"@actions/core": "^1.10.1",
1414
"@actions/github": "^6.0.0"
15-
}
15+
},
16+
"directories": {
17+
"test": "test"
18+
},
19+
"devDependencies": {},
20+
"repository": {
21+
"type": "git",
22+
"url": "git+https://github.com/voxelite/json-merge.git"
23+
},
24+
"bugs": {
25+
"url": "https://github.com/voxelite/json-merge/issues"
26+
},
27+
"homepage": "https://github.com/voxelite/json-merge#readme"
1628
}

0 commit comments

Comments
 (0)