Week 12: Lab 9: Packaged release

Introduction

In this weeks lab, I learned how to package my project and put it out there for others to be able to use. This allowed me to publish my package on npm and anyone can now access and use it on their own computer without having to clone my projects repository. In this blog, I will be going over how I managed to do this and the challenges I faced along the way.

Which release tool and package registry did you choose? Provide links to everything you mention.

For this lab, I used npm as my packaging tool for my project. This is because my project uses node, and npm is by far the most popular packaging tool for node projects. Here's the link for npm and how you can get started contributing packages to the registry:

First, install the package:

npm install -g auto-readme-liam

Then, provide your API key as an environment variable:

set GROQ_API_KEY="<YourAPIkey>"

Once you do this, run this command:

auto-readme-liam

And now you're set! You can also run this command for help:

auto-readme-liam --h