You are reading the 'README.md' file at the root of the source code directory of this project. This file is used to describe your project, what it does, how to deploy it and how to use it.
UPDATE: Look into using this free weather API: https://pirateweather.net/
Welcome to the 'TyRo' Module. This module is intented to be used for demo purposes and/or testing and experimenting.
It currently only has two CmdLets/Functions:
Get-Flow Gets river flow gage information at my two favorite white water kayaking spots.
Get-Snow Gets snow conditions and forecasts for Sugarloaf or Sunday River
Need to explain how to deploy this code to use the module.
Blank README.md template/example:
TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
- Installation process
- Software dependencies
- Latest releases
- API references
TODO: Describe and show how to build your code and run the tests.
TODO: Explain how other users and developers can contribute to make your code better.
If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files: