/yanayi

Yanayi is a CLI program that shows you the weather for a given city

Primary LanguageTypeScriptMIT LicenseMIT

Yanayi

Yanayi is a CLI program that shows you the current weather for a provided city, it also shows you the forecast for the next 3 days.

How to use without cloning the repo

To install Yanayi globally, you can run the following command:

$ npm install -g @vboechat/yanayi

To use Yanayi, you need to provide a city name, you can do it by running the following command:

$ yanayi city "Orlando"

If you want more details about the cli, you can run the following command:

$ yanayi --help

Local installation

If you want to install Yanayi locally, you will need to clone the repository and install the dependencies, you can do it by running the following commands:

$ git clone https://github.com/vboechat/yanayi.git
$ cd yanayi
$ npm install

Then, you can run the program by running the following command:

$ npm run start

This command will show you the help menu, you can use it to know how to use the program.

How to contribute

If you want to contribute to Yanayi, you can do it by following these steps:

  1. Fork this repository.
  2. Create a new branch: git checkout -b my-feature.
  3. Save your changes and create a commit message telling you what you did: git commit -m "feat: My amazing feature".
  4. Don't forget to run npm run build and submit your changes: git push origin my-feature.
  5. I will review your pull request.

License

This project is under the MIT license. See the LICENSE for more information.