Browse Source

Updates instructions and fixes a typo

master
sloum 3 months ago
parent
commit
702fcde67b
  1. 14
      README.md

14
README.md

@ -1,12 +1,16 @@
# slope packate registry
# slope package registry
This is the slope package registry. To have a package added:
- clone this repo
- add your project to `packages.json` following the instructions below
- commit your changes, including a tag name or version number in the module.json file
- fork this repo (if you do not already have a fork of it)
- add your module's json to `packages.json` within your forked 'packages' repo, following the instructions below
- commit your changes _in your module_, including a tag name or version number in the module.json file
- You wont have made the tag yet, so add the name that you _will_ use for the tag and then commit the changes
- if you used a tag and commited the changes, be sure to add and push the tag
- make a pull request into the `master` branch of this repository
- `git tag my-tag-name`, replacing `my-tag-name` with the name of your tag
- `git push origin my-tag-name`, replacing `my-tag-name` with the name of your tag
- make a pull request into the `master` branch of this repository from your forked version
- This will be done in the Pull Requests section of the git.rawtext.club website for _your_ fork of packages
When your pull request is approved (which it will be if the required json fields are present and your repository is a valid module) the package registry will be updated and `slp` will be able to pull in your code.

Loading…
Cancel
Save