change readme

This commit is contained in:
lucasdevelop 2021-07-28 00:33:35 +02:00
parent ab9538fc1f
commit 064f46b6aa
2 changed files with 81 additions and 6 deletions

View File

@ -1,10 +1,14 @@
# varkeeper
![npm](https://img.shields.io/npm/v/varkeeper) ![NPM](https://img.shields.io/npm/l/varkeeper) ![npm](https://img.shields.io/npm/dw/varkeeper) [![node-current](https://img.shields.io/node/v/varkeeper)](https://www.npmjs.com/package/varkeeper)
# varkeeper
![npm](https://img.shields.io/npm/v/varkeeper)
![NPM](https://img.shields.io/npm/l/varkeeper)
![npm](https://img.shields.io/npm/dw/varkeeper)
[![NPM](https://nodei.co/npm/varkeeper.png)](https://www.npmjs.com/package/varkeeper)
## Desciption
varkeeper is A tool for handle vars global
varkeeper is A tool for handle vars global in different modules
## Usage
@ -15,8 +19,79 @@ You can colormizer install using [npm](https://www.npmjs.com/package/varkeeper)
```
npm install varkeeper
```
```
yarn add varkeeper
```
```javascript
var vk = require('varkeeper');
```
## Functional
### set propertie
```javascript
vk.setprop("varName", "varValue");
```
### get propertie
```javascript
vk.getprop("varName");
```
### events
```javascript
vk.on("eventType",'varName', function(value){
//do something
}
```
evnetTypes:
- set
- get
- change
## OOP
## init propertie
```javascript
var vkObj = new vk.Prop("varName", "varValue");
```
## reference on exist propertie
```javascript
var vkObj = new vk.Prop("varName");
```
### set propertie
```javascript
vkObj.set("varValue");
```
### get propertie
```javascript
var vkObj = new vk.Prop("varName", "varValue");
vkObj.get();
```
### events
```javascript
vkObj.on("eventType", function (value) {
//do something
});
```
evnetTypes:
- set
- get
- change

View File

@ -1,7 +1,7 @@
{
"name": "varkeeper",
"version": "1.0.3",
"description": "varkeeper is A tool for handle vars global ",
"version": "2.0.0",
"description": "varkeeper is A tool for handle vars global in different modules ",
"main": "dist/index.js",
"files": [
"dist",