diff --git a/README.md b/README.md new file mode 100644 index 0000000..a00d803 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# NetboxPS +###### Powershell Netbox API module + +# Disclaimer +This module is beta. Use it at your own risk. All internal functions are exposed currently. Public functions are in the form of `verb-noun` like usual cmdlets. + +# Description +This module is a wrapper for the [Netbox](https://github.com/digitalocean/netbox) API. + +# Usage +1. Install module +2. Import module +3. Connect to an API endpoint by using `Connect-NetboxAPI` \ No newline at end of file