Merge pull request #15 from citusdata/feature/update_docs

Update project documentation

CONTRIBUTING.md

@@ -0,0 +1,85 @@
+Contributing to `mongo_fdw`
+===========================
+
+Following these guidelines helps to facilitate relevant discussion in pull
+requests and issues so the developers managing and developing this open source
+project can address patches and bugs as efficiently as possible.
+
+
+Using Issues
+------------
+
+`mongo_fdw`'s maintainers prefer that bug reports, feature requests, and pull
+requests are submitted as [GitHub Issues][1]. If you think you require personal
+assistance, please **do not** open an issue: email `engage` `@` `citusdata.com`
+instead.
+
+
+Bug Reports
+-----------
+
+Before opening a bug report:
+
+  1. Search for a duplicate issue using GitHub's issue search
+  2. Check whethe the bug remains in the lasest `master` or `develop` commit
+  3. Create a reduced test case: remove code and data not relevant to the bug
+
+A contributor should be able to begin work on your bug without asking too many
+followup questions. If you include the following information, your bug will be
+serviced more quickly:
+
+  * Short, descriptive title
+  * Your OS
+  * Versions of dependencies
+  * Any custom modifications
+
+Once the background information is out of the way, you are free to present the
+bug itself. You should explain:
+
+  * Steps you took to exercise the bug
+  * The expected outcome
+  * What actually occurred
+
+
+Feature Requests
+----------------
+
+We are open to adding features but ultimately control the scope and aims of the
+project. If a proposed feature is likely to incur high testing, maintenance, or
+performance costs it is also unlikely to be accepted. If a _strong_ case exists
+for a given feature, we may be persuaded on merit. Be specific.
+
+
+Pull Requests
+-------------
+
+Well-constructed pull requests are very welcome. By _well-constructed_, we mean
+they do not introduce unrelated changes or break backwards compatibility. Just
+fork this repo and open a request against `develop`.
+
+Some examples of things likely to increase the likelihood a pull request is
+rejected:
+
+  * Large structural changes, including:
+    * Refactoring for its own sake
+	* Adding languages to the project
+  * Unnecesary whitespace changes
+  * Deviation from obvious conventions
+  * Introduction of incompatible intellectual property
+
+Please do not change version numbers in your pull request: they will be updated
+by the project owners prior to the next release.
+
+
+License
+-------
+
+By submitting a patch, you agree to allow the project owners to license your
+work under the terms of the [`LICENSE`][2]. Additionally, you grant the project
+owners a license under copyright covering your contribution to the extent
+permitted by law. Finally, you confirm that you own said copyright, have the
+legal authority to grant said license, and in doing so are not violating any
+grant of rights you have made to third parties, including your employer.
+
+[1]: https://github.com/citusdata/mongo_fdw/issues
+[2]: LICENSE

LICENSE

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

Makefile

@@ -1,4 +1,7 @@
 # mongo_fdw/Makefile
+#
+# Copyright (c) 2012-2014 Citus Data, Inc.
+#
 
 MODULE_big = mongo_fdw