Add readme

This commit is contained in:
Ben Claussen 2018-05-18 12:36:38 -04:00
parent eebb1caf4a
commit 982b1dcf7a

13
README.md Normal file
View file

@ -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`