Skip to content
This repository was archived by the owner on Feb 19, 2024. It is now read-only.

Commit 09b10d8

Browse files
committed
actually edited it this time
1 parent 3456109 commit 09b10d8

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

readme.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ Zephyr has many CLI features built-in for running projects, creating new project
99

1010
To get help with the CLI, run `zephyr help`
1111

12+
## Repository
13+
14+
The Zephyr program has a built-in package manager that interacts with an external repository server.
15+
There is an "official" working one: https://zephyrrepository.itevie.repl.co
16+
However, if you'd like to create your own, go to [Zephyr Repository Server](https://github.com/itevie/ZephyrRepositoryServer)
17+
Help with the package manager CLI are below.
18+
1219
### Running a project
1320

1421
To run a project / file, use `zephyr [filename]` or `zephyr run [filename]`
@@ -18,14 +25,36 @@ Note: the recommended file extension for a Zephyr file is `.zr`
1825

1926
There IS an "official" package repository and it's: https://zephyrrepository.itevie.repl.co
2027
It's the default repository URL, don't spam it or anything please, thanks
21-
(Try the following server: https://zephyrrepository.itevie.repl.co)
2228

2329
`zephyr install-package [package-name] [package-version] (--repository [url])`
2430

2531
package-name: The name of the package
2632
package-version: The version of the package, or use `@latest` for the latest package
2733
repository: The URL of the repository server, e.g. `--repository http://localhost:3000` or `-r http://localhost:3000`
2834

35+
### Uploading a package
36+
37+
Uploading a package is very simple 1 line command.
38+
39+
First, make sure you're registered to the repository server, if not follow the registering section.
40+
41+
`zephyr upload-package -u [username] -p [password] (-r [url])`
42+
43+
Note:
44+
1. You need to be registered
45+
2. Zephyr must be running in a project folder with a package.json, if not it won't work.
46+
47+
### Registering
48+
49+
Registering to the repository server allows you to upload files etc.
50+
51+
To register run:
52+
53+
`zephyr register [username] [password] (-r [url])`
54+
55+
Usernames are alphanumeric (+ _) and 1-15 in length.
56+
If the repository server is not the official one, use a random password for the password.
57+
2958
### Creating a new project
3059

3160
Use `zephyr new` and it will guide you through creating a new project

0 commit comments

Comments
 (0)