Giter Site home page Giter Site logo

update-manager's Introduction

#update-manager

update-manager is a simple to use Node Packaged Module to keep all your files up to date.

There are several different use-cases. For example you can use it to deliver continuously new versions of your files. You can also use it for lazy loading.

##How it works The usage is quite simple. You simply call the update-manager with a config object which contains a extractPath and a URL to a version.json.

Everytime the update-manager is called, he compares the local version and the remote version. If the remote version is greater than the local, the download starts automatically.

###Installation

npm install update-manager

###The version file

{
    "version": "1.1.1",
    "updateURL": "http://example.com/path/to/your/files.zip"
}

###How to use

var updateManager = require('update-manager');

var config = {
    updateVersionURL: 'http://example.com/path/to/your/version.json',
    extractPath: 'global/path/to/your/dest'
}

// everytime init() is called, the update-manager looks for a new available version
function init() {
    updateManager.update(config);
}

##Licence

The MIT License (MIT)

Copyright (c) 2014 M-Way Solutions GmbH.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

update-manager's People

Contributors

timoweiss avatar broud avatar

Stargazers

Steffen Gorenflo avatar  avatar Stefan Buck avatar

Watchers

zbage avatar MWAY DIGITAL GmbH avatar hano avatar James Cloos avatar Yiivon avatar Thomas Beckmann avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.