Added missing README.md file

Author: jaredhendrickson13

README.md

@@ -0,0 +1,32 @@
+pfSense API
+===========
+# Introduction
+pfSense API is a fast, safe, full-fledged API based on REST architecture. This works by leveraging the same PHP functions and processes used by pfSense's webConfigurator into API endpoints to create, read, update and delete pfSense configurations. All API endpoints enforce input validation to prevent invalid configurations from being made. Configurations made via API are properly written to the master XML configuration and the correct backend configurations are made preventing the need for a reboot. All this results in the fastest, safest, and easiest way to automate pfSense!
+
+# Installation
+To install pfSense API, simply run the following command from the pfSense shell:<br>
+`pkg add https://github.com/jaredhendrickson13/pfsense-api/releases/v0.0.1/pfSense-pkg-API-0.0_1.txz`<br>
+
+To uninstall, run the following command:<br>
+`pkg delete pfSense-pkg-API`<br>
+
+_Note: if you do not shell access to pfSense, you can install via the webConfigurator by navigating to 'Diagnostics > Command Prompt' and enter the commands there_
+
+# Requirements
+- pfSense 2.4.4 or later is required
+- pfSense API requires a local user account in pfSense. The same permissions required to make configurations in the webConfigurator are required to make calls to the API endpoints
+- While not an enforced requirement, it is STRONGLY recommended that you configure pfSense to use HTTPS instead of HTTP
+
+# Authentication
+By default, pfSense API uses the same credentials as the webConfigurator. Alternatively, you can configure pfSense API to create secure API client IDs and tokens for API users. To generate, or delete API keys you can navigate to `System > API` in the UI after installation, and change the authentication mode to `API Token`.
+
+# Response Codes
+`200 (OK)` : API call succeeded<br>
+`400 (Bad Request)` : There was an error with your requested parameters<br>
+`401 (Unauthorized)` : API client has not completed authentiation or authorization successfully<br>
+`403 (Forbidden)` : The API endpoint has refused your call<br>
+`404 (Not found)` : Either the API endpoint or requested data was not found<br>
+`500 (Server error)` : The API endpoint encountered an unexpected error processing your API request<br>
+
+# Rate limit
+There is no limit to API calls at this time