Reference

Author: daftspunk

api/api.md

@@ -0,0 +1,25 @@
+# API Reference
+
+## Common Attribute Reference
+
+The following are core attributes that you will reach for commonly.
+
+Attribute | Description
+--------- | ------------
+[data-request](#) | Makes a request to a given AJAX handler
+[data-request-data](#) | Supplies postback data with the request
+[data-request-trigger](#) | The event that triggers the request
+
+## Additional Attribute Reference
+
+All other attributes are specified below.
+
+Attribute | Description
+--------- | ------------
+[data-request-query](#) | Supplies query data with the request and modifies the URL
+[data-request-confirm](#) | Displays a confirmation message before sending the request.
+[data-request-before-update](#) | Execute JavaScript before the page contents are updated.
+[data-request-success](#) | Execute JavaScript on a successful request.
+[data-request-error](#) | Execute JavaScript on a failed request.
+[data-request-complete](#) | Execute JavaScript on every completed request.
+[data-request-cancel](#) | Execute JavaScript if the user aborts the request or cancels it via a confirmation dialog.

api/reference.md

@@ -11,17 +11,18 @@ npm i larajax
 
 ```php
 // Controller
-public function onSave() {
+public function onSave()
+{
     // ...
     return ['#message' => view('partials.message')];
 }
 ```
 
 ## What problem are we solving?
 
-Primarily it is API access. We often need to define two types of endpoints, pages that render to the browser and API endpoints that perform actions (usually RESTful).
+Primarily Larajax is useful for defining _internal_ APIs that are defined and consumed by the same application. We often need to define two types of endpoints, pages that render to the browser and API endpoints that perform actions (usually RESTful).
 
-The problem with RESTful endpoints is they can quickly get disorganised, since they are global to the application by default. For example, a simple profile page may look like this:
+The problem with using RESTful endpoints as internal APIs is they can quickly get disorganised, since they are global to the application by default. For example, a simple profile page may look like this:
 
 ```php
 Route::get('/user-profile', ...);