Update README.md

This commit is contained in:
Casper Warden
2017-12-18 19:55:37 +00:00
committed by GitHub
parent 37a21e249c
commit aa381db020

View File

@@ -12,7 +12,64 @@ npm install --save @caspertech/node-metaverse
## Usage
TODO
Javascript
```javascript
const nmv = require('@caspertech/node-metaverse');
const loginParameters = new nmv.LoginParameters();
loginParameters.firstName = 'firstName';
loginParameters.lastName = 'lastName';
loginParameters.password = 'password';
loginParameters.start = "last";
const options = nmv.BotOptionFlags.LiteObjectStore | nmv.BotOptionFlags.StoreMyAttachmentsOnly;
const bot = new nmv.Bot(loginParameters, options);
bot.login().then((response) =>
{
console.log("Login complete");
//Establish circuit with region
return bot.connectToSim();
}).then(() =>
{
console.log("Connected");
}).catch((error) =>
{
console.error(error);
});
```
Typescript
```typescript
import {Bot, BotOptionFlags, LoginParameters} from '@caspertech/node-metaverse';
const loginParameters = new LoginParameters();
loginParameters.firstName = 'firstName';
loginParameters.lastName = 'lastName';
loginParameters.password = 'password';
loginParameters.start = 'last';
const options = BotOptionFlags.LiteObjectStore | BotOptionFlags.StoreMyAttachmentsOnly;
const bot = new Bot(loginParameters, options);
bot.login().then((response) =>
{
console.log("Login complete");
//Establish circuit with region
return bot.connectToSim();
}).then(() =>
{
console.log("Connected");
}).catch((error) =>
{
console.error(error);
});
```
## License