Coder Social home page Coder Social logo

webcomponents-update-reminder's Introduction

Webcomponents-update-reminder

Remind your user to update your components just by adding one line

Get start

To use this element in your components:

<!-- import this element just like you do to other web components -->
<!-- you can add async tag to this as it won't effect the render of the page -->
<link rel="import" href="../webcomponents-update-reminder/webcomponents-update-reminder.html" async>

<!-- adding this inside your web component -->
<webcomponents-update-reminder
    repo="YOUR ELEMENT'S GITHUB REPO, FOR EXAMPLE: PolymerElements/paper-toolbar">
</webcomponents-update-reminder>

That's all! When your component have a new version, the user will recieve a info like this:

a info in console

The element will read your repo's release tag and compare it with the local bower.json to detect if there is a new version, only minor and major version update will remind user to update (unless your element's major version is 0). Your user will recieve a message in console when developing on localhost or 127.0.0.1.

You need to mention that the version tag in your bower.json should be look like X.Y.Z, the release tag in your github repo should be look like vX.Y.X or X.Y.Z. We recommend naming tags that fit within semantic versioning.

Let's build together!

This element is still building. If you're interested in it, you can help building it together!

webcomponents-update-reminder's People

Contributors

markhuang1212 avatar

Watchers

 avatar

Forkers

orenbochman

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.