Added a few examples on the setup and usage

Author: Nicklason

.eslintignore

@@ -1 +1,2 @@
-local
+local
+examples

examples/get-name.js

@@ -0,0 +1,22 @@
+const Schema = require('tf2-schema');
+
+const schemaManager = new Schema({ apiKey: 'your steam api key' });
+
+schemaManager.init(function (err) {
+    if (err) {
+        throw err;
+    }
+});
+
+schemaManager.on('ready', function () {
+    // item object to get the name off, only the defindex and quality is required
+    const item = {
+        defindex: 5021,
+        quality: 6
+    };
+
+    // get the name of the item
+    const name = schemaManager.schema.getName(item);
+
+    console.log(name); // -> Mann Co. Supply Crate Key
+});

examples/schema-cache.js

@@ -0,0 +1,30 @@
+const Schema = require('tf2-schema');
+const fs = require('fs');
+
+const SCHEMA_PATH = './path-to-schema-file.json';
+
+const schemaManager = new Schema({ apiKey: 'your steam api key' });
+
+if (fs.existsSync(SCHEMA_PATH)) {
+    // a cached schema exists
+
+    // read and parse the cached schema
+    const cachedData = JSON.parse(fs.readFileSync(SCHEMA_PATH));
+
+    // set the schema data
+    schemaManager.setSchema(cachedData);
+}
+
+// initialize tf2-schema like normally
+schemaManager.init(function (err) {
+    if (err) {
+        throw err;
+    }
+});
+
+schemaManager.on('schema', function (schema) {
+    // this event is emitted when the schema has been fetched
+
+    // writes the schema data to disk
+    fs.writeFileSync(SCHEMA_PATH, JSON.stringify(schemaManager.toJSON()));
+});

examples/setup.js

@@ -0,0 +1,18 @@
+const Schema = require('tf2-schema');
+
+// Create new instance of tf2-schema
+const schema = new Schema({ apiKey: 'your steam api key' });
+
+// Initialize tf2-schema
+schema.init(function (err) {
+    if (err) {
+        // Error occurred fetching the schema
+        throw err;
+    }
+
+    // tf2-schema is now ready to be used
+});
+
+schema.on('ready', function () {
+    // this event is emitted when the init function has been called and finished without errors
+});