systemlynx 1.1.0 → 1.2.0

package/API.md

@@ -73,10 +73,10 @@ Welcome to the docs! Following is a list of the objects used and created when de
 
 ## App
 
-**App** combinds the both functionalites of SystemLynx Service and Client into one object, while also providing a module interface and lifecycle events. Access the App instance by deconcatanating from the object return when loading SystemLynx `require("sht-tasks")`.
+**App** combinds the both functionalites of SystemLynx Service and Client into one object, while also providing a module interface and lifecycle events. Access the App instance by deconcatanating from the object return when loading SystemLynx `require("systemlynx")`.
 
 ```javascript
-const { App } = require("sht-tasks");
+const { App } = require("systemlynx");
 ```
 
 ## App.ServerModule(name, constructor [,reserved_methods])
@@ -108,10 +108,10 @@ Use **App.ServerModule(name, constructor)** function to create or pass an object
 
 Service is a SystemLynx abstraction used to server objects that can be loaded by a SystemLynx Client using the `Client.loadService(url)` method.
 
-Call require("sht-tasks") and de-concatenate from the object it returns.
+Call require("systemlynx") and de-concatenate from the object it returns.
 
 ```javascript
-const { Service } = require("sht-tasks");
+const { Service } = require("systemlynx");
 ```
 
 The Service object has the following methods:
@@ -127,7 +127,7 @@ The Service object has the following methods:
   Use the `Service.ServerModule(name, constructor, [,options])` method to register an object to be hosted by a _SystemLynx Service_. This will allows you to load an instance of that object onto a client application, and call any methods on that object remotely.
 
 ```javascript
-const { Service } = require("sht-tasks");
+const { Service } = require("systemlynx");
 
 const Users = {};
 

package/README.md

@@ -5,10 +5,10 @@ SystemLynx is a framework for developing modular web APIs. It's a wrapper on top
 SystemLynx comes with the following objects that are used for web API development:
 
 ```javascript
-const { App, Service, Client, LoadBalancer } = require("sht-tasks");
+const { App, Service, Client, LoadBalancer } = require("systemlynx");
 ```
 
-Call `require("sht-tasks")` and de-concatenate from the object it returns. The main abstractions used for client-to-server interactions are the following:
+Call `require("systemlynx")` and de-concatenate from the object it returns. The main abstractions used for client-to-server interactions are the following:
 
 - **Service** - Used to create and host objects that can be loaded and used by a SystemLynx Client.
 - **Client** - Used in a client application to load a _Service_, which contains all the objects added to the _Service_.
@@ -25,7 +25,7 @@ Find the full [API Documentation](https://github.com/Odion100/SystemLynx/blob/ta
 Use the `Service.ServerModule(name, constructor/object)` method to register an object to be hosted by a _SystemLynx Service_. This will allows you to load an instance of that object onto a client application, and call any methods on that object remotely.
 
 ```javascript
-const { Service } = require("sht-tasks");
+const { Service } = require("systemlynx");
 
 const Users = {};
 
@@ -43,7 +43,7 @@ Alternatively, you can use a constructor function instead of an object as the se
 "Orders".
 
 ```javascript
-const { Service } = require("sht-tasks");
+const { Service } = require("systemlynx");
 
 const Users = {};
 
@@ -71,7 +71,7 @@ In the _ServerModule_ constructor function above, the `this` value is the init
 Before we can access the objects hosted by this _Service_ from a client application, we need to call the `Service.startService(options)` function. This will start an **ExpressJS** Server and a **Socket.io** WebSocket Server, and set up routing for the _Service_. In the example below we added the `Service.startService(options)` function at the bottom, but the order does not matter.
 
 ```javascript
-const { Service } = require("sht-tasks");
+const { Service } = require("systemlynx");
 
 const Users = {};
 
@@ -101,7 +101,7 @@ Now lets see how these objects can be loaded into a client application.
 The `Client.loadService(url)` function can be used to load a SystemLynx _Service_. This method requires the url (string) of the _Service_ you want to load as the first argument, and will return a promise that will resolve into an object that containing all the modules hosted by that service. See below. **NOTE: You must be within an async function in order to use the `await` keyword when returning a promise.**
 
 ```javascript
-const { Client } = require("sht-tasks");
+const { Client } = require("systemlynx");
 
 const { Users, Orders } = await Client.loadService("http://localhost:4400/test/service");
 
@@ -111,7 +111,7 @@ console.log(Users, Orders);
 Now that we've loaded the _Service_ that we created in the previous example, and have a handle on the _Users_ and _Orders_ objects hosted by the _Service_, we can now call any method on those objects. In the example below, we demonstrate that when a methods for the ServerModule objects is called from the client, it can optionally take a callback as the last argument or, if a callback is not used, it will return a promise. With the `Users.add(data, callback)` method we used a callback, but with the `Orders.find(arg1, arg2, callback)` method we left out the callback function and used the `await` keyword to return a promise.
 
 ```javascript
-const { Client } = require("sht-tasks");
+const { Client } = require("systemlynx");
 
 const { Users, Orders } = await Client.loadService("http://localhost:4400/test/service");
 
@@ -132,7 +132,7 @@ console.log(response);
 We can also receive WebSocket events emitted from the remote objects we've loaded using the `Client.loadService(url)` function. In the example below we're using the `Users.on(event_name, callback)` method to listen for events coming from the "Users" _ServerModule_.
 
 ```javascript
-const { Client } = require("sht-tasks");
+const { Client } = require("systemlynx");
 
 const { Users, Orders } = await Client.loadService("http://localhost:4400/test/service");
 
@@ -155,7 +155,7 @@ console.log(response);
 Now let's go to our server application and call the `Users.emit(event_name, data)` method to emit a websocket event that can be received by its corresponding Clients. Below, notice that we've added `Users.emit("new_user", { message:"new_user event test" })` at the end of the `Users.add` method, so the `new_user` event will be emitted every time this method is called.
 
 ```javascript
-const { Service } = require("sht-tasks");
+const { Service } = require("systemlynx");
 
 const Users = {};
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "systemlynx",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "",
   "main": "index.js",
   "scripts": {