added commands.md

This commit is contained in:
Mohammed Ashab Uddin
2020-07-21 14:10:42 +04:00
parent d7adb17b37
commit 97e7e4ae85
3 changed files with 47 additions and 1 deletions

View File

@@ -15,7 +15,6 @@ if (fs.existsSync(SESSION_FILE_PATH))
const client = new Client({ puppeteer: { headless: false }, session: sessionCfg });
client.initialize();
client.on('qr', (qr) =>
{
console.log('QR RECEIVED', qr);
@@ -32,10 +31,12 @@ client.on('authenticated', (session) =>
}
});
});
client.on('auth_failure', (msg) =>
{
console.error('AUTHENTICATION FAILURE', msg);
});
client.on('ready', () =>
{
console.log('READY');

View File

@@ -1,4 +1,20 @@
const { Website } = require("../models/website");
const { data } = require("../models/data");
module.exports.onWG = () => {
console.log('hello world');
}
module.exports.onCreate = (id, companyName) => {
//get the user
let user = data.getUser(id);
if(user == undefined)
{
data.addUser(id);
user = data.getUser(id);
}
//add the website with the company name
user.addWebsite(new Website(companyName));
}

View File

@@ -0,0 +1,29 @@
# Commands available for user interaction
*wg* -> Command wg help to get the avaialabe instructions
*wg help* -> The following are the available commands:
*wg create <company name> -> creates a framework for the website after getting details of the website
# Following commands only works when a website is created
*wg product all* -> shows all the products that are created
*wg product new* -> creates a new product with generated Id
*wg product <id>* -> if the id exists, the product with “id“ is selected, else, create a new product with the id given
# NOTE :
User should be given feedback on their commands. For example:
If a user created a product, the bot should reply, "a product has been created with the id : <id>"
If a user created a product without a website, the bot should handle the error and reply, "A website should be selected or created before creating a product"
# Following command only works if a product is selected
*wg product info* -> shows the information about the product. Ie name, cost, description, image
*wg product name* <product-name> -> set the name of the product
*wg product cost* <product-cost> -> set the cost of the product
*wg product desc* <product-desc> -> set the description of the product
*wg product image* <product-image> -> sets the image of the product. The caption of the image should be the command.
*wg finished* -> creates the website and gives a link to the website maker
# Note:
If you think these commands are not enough, please add them in a seperate section with a clear defination.