aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorUnknown2018-04-02 20:25:28 +0100
committerUnknown2018-04-02 20:25:28 +0100
commitd461d20df08ec76e73a0ce5335dd4665ec024fbd (patch)
treed41e91ed6b8561afc706951c41bc85a0a3231d1d /README.md
parentf6cd20047e7ef22432c31a39ee00b5e52890e66f (diff)
add get and rm
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 89a9d76..1062e9b 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,10 @@ Unfinished!
Firstly, make sure that [CORS is enabled on your webserver](https://enable-cors.org/server.html).
If it isn't on, your users will be unable to download packages!
Secondly you need to create a repo.json in the folder where you want your repository to be in.
+In it, there should be 4 keys.
+- `name` This is your repo's name.
+- `msg` This is your repo's message to all visitors.
+- `packages` This is an array containing all the names of packages.
Here's an example:
```json
{
@@ -40,16 +44,14 @@ Firstly, you want to make a new folder called the name of the package.
Then, you want to make a file called package.json in the folder.
In it, there should be 4 keys.
- `"name"`: **Must be the same as the folder name and command name!**
-- `"version"`: An array of 3 numbers, 1st number is major, 2nd number is minor, 3rd number is patch.
- `"inject"`: It should be the name of the injection script.
- `"uninstall"`: Optional, It should be the name of the uninstaller script, if it doesn't exist pkg93 will simply delete the command for you.
Here's a example:
```json
{
"name": "examplepkg",
- "version": [1, 3, 7],
"inject": "installer.js",
- "uninstall": "mypointlessuninstaller.js"
+ "uninstall": "optionaluninstaller.js"
}
```
And the directory structure:
@@ -57,5 +59,5 @@ And the directory structure:
examplepkg
├── package.json
├── installer.js
-└── mypointlessuninstaller.js
+└── optionaluninstaller.js
```