RingMe.js

A library to render a Ring Me button on your website. The best way to bring Ring communication to your website!

What is Ring

Ring is free software for universal communication which respects freedoms and privacy of its users.

See official Ring website to join the Ring

Communication

The easiest way to communicate with us is by opening a new issue. Make sure you add proper labels to your issue (e.g. question, issue, enhancement, …)

Usage

Why you don't need it

This project does nothing other than to propose a default look and feel for a Ring Me button that you can easily add to any Web page.

You could simply choose to not use this Javascript project and add a link on your page like so:

<a href="ring:my-ring-ID">Call me with Ring, a communication tool that respects your freedoms and privacy</a>

as you would add a link on your page to let your visitors email you:

<a href="mailto:[email protected]">Email me!</a>

The magic happens through the Ring client that configures your computer to handle the ring: scheme.

Why you need it

Since Ring clients are not as widely used as email clients (yet), this little project helps by identifying if the ring: scheme can be handled by a visitor's computer.

It also proposes a unified look and feel for a Ring me button that will soon be recognizable by visitors.

Installation

This is still in pre-alpha state. No installation process yet and needed feature in Ring's clients might not yet be available in released branch.

Sure thing though, you should want to use this library from a server you control and prefer a self-hosted solution on your website instead of pointing to a CDN in order to avoid a call home feature that wouldn't necessarily respect your privacy.

This section will be updated with proper information as soon as this becomes robust and stable.

How to contribute

Please refer to the contribution guidelines

Licensing

Ringme.js is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

ringme.js is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with ringme.js. If not, see http://www.gnu.org/licenses/.

with ♥ from Savoir-faire Linux