Skip to content

Commit 92b6e82

Browse files
committed
readme
1 parent 621a42f commit 92b6e82

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
11
# ShopAPI
2-
A BeAPI module that allows you to simply make fully modular shops for your worlds.
2+
3+
ShopAPI is a [BeAPI](https://github.com/MCBE-Utilities/BeAPI) module that world/server owners to create unique shops for their maps.
4+
5+
## Installing
6+
* Requirements
7+
* [node.js](https://nodejs.org/)
8+
* [BeAPI](https://github.com/MCBE-Utilities/BeAPI)
9+
10+
To download and install, you can either git clone this repo and use the mcpe pack, or run the command below in your BeAPI project.
11+
```npm install @mcbeutils/shopapi```
12+
Once you have done that, you can now import "@mcbeutils/shopapi" into your main project.
13+
![image](public/import.png)

tsconfig.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"sourceMap": false,
1212
"skipLibCheck": true,
1313
// Set declaratoin to true when creating a module.
14-
"declaration": false
14+
"declaration": true
1515
},
1616
"include": ["src"]
1717
}

0 commit comments

Comments
 (0)