Skip to content

Update git commands in ReadMe #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shdwmtr merged 1 commit into from
May 3, 2025
Merged

Update git commands in ReadMe #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,29 @@
> This repository solely exists for developers to submit plugins.<br>
> Download & install plugins from https://steambrew.app/plugins

&nbsp;

### Submitting A Plugin

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

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.
This is in place to prevent malicious code by forcing us to audit all of your code changes.
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.
This is in place to prevent malicious code by forcing us to audit all of your code changes.

&nbsp;

### Updating Your Plugin

Once you have your submodule added, in order to update it,
change directories to `plugins/your-plugin` and run `git submodule update --init`.
This should update your plugin to the latest version.
change directory to `plugins/your-plugin`, checkout the branch you wish to use and pull:
```
git checkout your-plugin-branch
git pull
```
This should update your plugin to the latest version. Commit the change and open a pull request.

&nbsp;

In case you wish to clone plugins at their attached commits, run `git submodule update --init`.
Loading