## README

Welcome to the Verox docs

# What does verox do?

Verox is an npm package containing some basic functions.

**Firstly, lets install it!**

```
npm i Verox
```

*Math functions*

```
//Require the module
const Verox = require("verox");
//Addition
console.log(Verox.math.add(25,25))
//The first param is the first number you want to add to the second number.
//Multiplication
console.log(Verox.math.multiply(25,25))
//Same with addition, first param is the first number you want to times by the second number.
//Division
console.log(Verox.math.divide(2,24))
//The first param is what you want to divide by, the second param / number is what you want to divide the first number into.
//Subtraction
console.log(Verox.math.subtract(2,24))
//The first param is what you will subtract from the second param.
```

*Useful functions*

```
//Require the module
const Verox = require("verox");
//MemUsage
console.log(Verox.useful.memusage())
//Gets the memusage for the current machine running the node.
//Log
Verox.useful.log('What you want to put on the log')
//Exit the node
Verox.useful.exit()
//Fetch a website
Verox.useful.fetch("link.com");
//You need to use await to fetch it.
```

*String functions*

```
const Verox = require("verox");
let str = 'fs is amazing'
console.log(Verox.string.replace(str,'fs','verox'))
//The first param is the string, second param are the characters to look for, the third param if what you want to replace the second param with.
//Would log: verox is amazing
```

**Advanced docs are coming!**
Please invite my discord bot here