Skip to content

How to add your module to the directory

jbuedel edited this page Feb 8, 2012 · 4 revisions

Ideal

  1. Get link to your module (PSM1 or ZIP file)
  2. Fork https://github.com/chaliy/psget/
  3. Find Directory.xml, this is atom feed with all modules
  4. Add or update your module (take any other module as example)
  5. Test your added module using your local Directory.xml as the module source: install-module mynewmodule -DirectoryUrl "file://${pwd}/Directory.xml".
    This assumes your current directory is your git checkout directory; otherwise replace ${pwd} with the appropriate path.
  6. Commit and send me pull request.
  7. In short time it will be available in main repo.

Super Lazy

  1. Create ticket in Issues section, put some information how to find your module
  2. In some time it will be available in main repo

FAQ

How to package module?

If you have single PSM1 file, you are done. Nothing else is needed or required. If your module is more then one script or have resources like images or even DLLs. Just ZIP module folder. PsGet is smart enough to find module within your ZIP file.

Where to get link?

If you have single PSM1 file and you host it on GitHub, just give a raw link, something like https://raw.github.com/chaliy/psurl/master/PsUrl/PsUrl.psm1 . If you want to distribute as ZIP and you host your code on GitHub, you can find ZIP button on your repository home page and copy link, something like http://github.com/chaliy/psget/zipball/master , this will be link to your ZIP file. Also you can find links to ZIP files for your tags.

How to execute arbitrary code after install?

Add install.ps1 file to your package. PsGet will run it automatically.