[#1] Add docs and public interface, closes #1

Author: alejandromav

README.md

@@ -2,19 +2,26 @@
 ![](https://github.com/schemadb/node-sdk/workflows/CI/badge.svg)
 
 ## Usage
-`// TODO`
+
+This library is documented in: [https://schemadb.github.io/node-sdk](https://schemadb.github.io/node-sdk)
 
 ## Development
-`// TODO`
 
-### Setup
-`// TODO`
+```bash
+# Fork and clone this repo
+npm i
+
+# You can keep track of tests status while making changes
+npm run test:watch
 
-### Test
-`// TODO`
+# And make sure everythign is fine after changes
+npm run lint
+npm run test
+```
 
 ### Contribute
-`// TODO`
+
+[CONTRIBUTING.md](./CONTRIBUTING.md)
 
 ## Maintainers
 

docs/api-reference.markdown

@@ -0,0 +1,9 @@
+---
+layout: default
+title: API Reference
+nav_order: 3
+---
+
+# API Reference
+
+*Work in progress*

docs/index.markdown

@@ -6,16 +6,16 @@ nav_order: 1
 
 # Home
 
-Lorem ipsum is placeholder text commonly used in the graphic, print, and publishing industries for previewing layouts and visual mockups.
+This is the Node.js SDK for [https://schemadb.com](https://schemadb.com).
 
-## Install
+**WARNING: this is still WIP.**
+
+## Installation
 
 ```bash
 npm i @schemadb/node-sdk
 ```
 
 ## Usage
 
-```js
-const { someMiddleware } = require('@schemadb/node-sdk');
-```
+Please, have a look at [Quickstart](./quickstart.markdown).

docs/quickstart.markdown

@@ -0,0 +1,76 @@
+---
+layout: default
+title: Quickstart
+nav_order: 2
+---
+
+# Quickstart
+
+First of all, login to [https://schemadb.com](https://schemadb.com) and head to API Tokens page. you can create a new one over there.
+
+## Initialize
+```js
+const schemadb = require('@schemadb/node-sdk');
+schemadb.init('1036fae0-3a28-11ea-a5e3-...');
+
+// You can also pass some options
+schemadb.init('1036fae0-3a28-11ea-a5e3-...', {
+    debug: true
+});
+```
+
+Available options are:
+
+| Option | Description | Type | Default value |
+| ------ | ----------- | ---- | ------------- |
+| `debug` | Enabled debug logging level | `Boolean` | `false` |
+
+## Save a new schema
+
+```js
+const orderSchema = {
+	"version": 1,
+	"definition": {
+		"type": "record",
+		"namespace": "com.example.store",
+		"name": "order",
+		"fields": [
+          { "name": "orderId", "type": "long" },
+          { "name": "storeId", "type": "long" },
+          {
+          	"name": "timepalced",
+           	"type": "long",
+          	"logicalType": "timestamp-millis" 
+          },
+          { "name": "orderStatus", "type": "string" }
+        ]
+	}
+};
+
+// Save schema to platform
+await schemadb.saveSchema(orderSchema);
+```
+
+## Encode payload
+
+Schemas will be fetched only once from after instantiated, since the SDK handles caching for you.
+
+```js
+// Get latest schema by namespace and name
+const schema = await schemadb.getSchema('com.example.store', 'order');
+
+// Encode payload
+const avro = await schemadb.encode(schema, {
+    orderId: 1234567890,
+    storeId: 1234,
+    timeplaced: 1586193018930,
+    orderStatus: 'A'
+});
+```
+
+## Decode binary Avro
+
+```js
+// Decode binary buffer to JSON object
+const payload = await schemadb.decode(avroBinaryBuffer);
+```

docs/test.markdown

@@ -1,3 +1,5 @@
+/* eslint-disable no-unused-vars */
+
 import Exceptions from './lib/exceptions';
 import { setConfiguration, Settings } from './stores/configuration';
 
@@ -9,7 +11,7 @@ const _validateAPIToken = apiToken => {
 
 export default {
     /**
-     * Initialize SchemaDB SDK
+     * Initialize SchemaDB SDK.
      * 
      * @param {string} apiToken SchemaDB API Token
      * @param {object} options SDK options
@@ -22,5 +24,39 @@ export default {
         }
 
         setConfiguration(Settings.DEBUG, !!options[Settings.DEBUG]);
+    },
+    /**
+     * Save a new schema to platform. Will fail if version already exists.
+     * 
+     * @param {object} schema Avro JSON format schema to be saved
+     */
+    saveSchema: async (schema) => {
+        return;
+    },
+    /**
+     * Get latest schema version by namespace and name.
+     * 
+     * @param {string} namespace Schema namespace
+     * @param {string} name Schema name
+     */
+    getSchema: async (namespace, name) => {
+        return;
+    },
+    /**
+     * Encode JSON to binary Avro buffer.
+     * 
+     * @param {object} schema Avro JSON format schema to be saved
+     * @param {object} payload Object to be encoded
+     */
+    encode: async (schema, payload) => {
+        return;
+    },
+    /**
+     * Decado Avro binary to JSON object.
+     * 
+     * @param {Buffer} binaryBuffer Avro binary encoded payload
+     */
+    decode: async (binaryBuffer) => {
+        return;
     }
 };