Skip to content

Commit ac0e971

Browse files
committed
Update git commands in ReadMe
1 parent 3436eb9 commit ac0e971

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,29 @@
55
> This repository solely exists for developers to submit plugins.<br>
66
> Download & install plugins from https://steambrew.app/plugins
77
8+
&nbsp;
9+
810
### Submitting A Plugin
911

10-
To submit a plugin to Millennium's plugin repository, open a pull request that adds your plugin as a submodule using the command below
11-
`git submodule add https://github.com/YourUsername/YourRepository /plugins`
12+
To submit a plugin to Millennium's plugin repository, open a pull request that adds your plugin as a submodule using the command
13+
`git submodule add https://github.com/YourUsername/YourRepository your-plugin`
14+
inside the `plugins` directory.
1215

13-
This will attach your repository from a specific commit, meaning when you update your repository, the changes wont be reflected here unless you open a pull request to update it.
14-
This is in place to prevent malicious code by forcing us to audit all of your code changes.
16+
This will attach your repository from a specific commit, meaning when you update your repository, the changes won't be reflected here, unless you open a pull request to update it.
17+
This is in place to prevent malicious code by forcing us to audit all of your code changes.
1518

1619
&nbsp;
1720

1821
### Updating Your Plugin
1922

2023
Once you have your submodule added, in order to update it,
21-
change directories to `plugins/your-plugin` and run `git submodule update --init`.
22-
This should update your plugin to the latest version.
24+
change directory to `plugins/your-plugin`, checkout the branch you wish to use and pull:
25+
```
26+
git checkout your-plugin-branch
27+
git pull
28+
```
29+
This should update your plugin to the latest version. Commit the change and open a pull request.
30+
31+
&nbsp;
32+
33+
In case you wish to clone plugins at their attached commits, run `git submodule update --init`.

0 commit comments

Comments
 (0)