From 65da0ebd389fba9d0f5706ae55799ca4ef5db214 Mon Sep 17 00:00:00 2001 From: Matteo Collina Date: Fri, 9 Jan 2015 09:11:03 +0100 Subject: [PATCH] OPEN Open Source project! --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ LICENSE | 20 -------------------- LICENSE.md | 15 +++++++++++++++ README.md | 24 +++++++++++++++++++++++- package.json | 2 +- 5 files changed, 66 insertions(+), 22 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 LICENSE create mode 100644 LICENSE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..cbe1f77f7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# mqtt-packet is an OPEN Open Source Project + +----------------------------------------- + +## What? + +Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project. + +## Rules + +There are a few basic ground-rules for contributors: + +1. **No `--force` pushes** or modifying the Git history in any way. +1. **Non-master branches** ought to be used for ongoing work. +1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors. +1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor. +1. Contributors should attempt to adhere to the prevailing code-style. + +## Releases + +Declaring formal releases remains the prerogative of the project maintainer. + +## Changes to this arrangement + +This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change. + +----------------------------------------- diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 693d1a518..000000000 --- a/LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright (C) 2011-2014 by Adam Rudd -Copyright (C) 2013-2014 by Matteo Collina - -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. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 000000000..07df702d3 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,15 @@ +The MIT License (MIT) +===================== + +Copyright (c) 2015 MQTT.js contributors +--------------------------------------- + +*MQTT.js contributors listed at * + +Copyright 2011-2014 by Adam Rudd + +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. diff --git a/README.md b/README.md index d11336ba5..c1790ed82 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,18 @@ [![NPM](https://nodei.co/npm-dl/mqtt.png)](https://nodei.co/npm/mqtt/) MQTT.js is a client library for the [MQTT](http://mqtt.org/) protocol, written -in JavaScript to be used in node.js and the browser. +in JavaScript for node.js and the browser. * [Upgrade notes](#notes) * [Installation](#install) * [Example](#example) * [Command Line Tools](#cli) * [API](#api) +* [Contributing](#contributing) * [License](#license) +MQTT.js is an OPEN Open Source Project, see the [Contributing](#contributing) section to find out what this means. + Important notes for existing users ---------------------------------- @@ -298,6 +301,25 @@ The callback is called when the packet has been removed. Closes the Store. + +Contributing +------------ + +MQTT.js is an **OPEN Open Source Project**. This means that: + +> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project. + +See the [CONTRIBUTING.md](https://github.com/mqttjs/MQTT.js/blob/master/CONTRIBUTING.md) file for more details. + +### Contributors + +MQTT.js is only possible due to the excellent work of the following contributors: + + + + +
Adam RuddGitHub/adamvrTwitter/@adam_vr
Matteo CollinaGitHub/mcollinaTwitter/@matteocollina
+ License ------- diff --git a/package.json b/package.json index acce42fcd..d28bbc7ca 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,9 @@ { - "author": "Adam Rudd ", "name": "mqtt", "description": "A library for the MQTT protocol", "version": "1.0.0-pre.5", "contributors": [ + "Adam Rudd ", "Matteo Collina (https://github.com/mcollina)" ], "keywords": [