Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add README, LICENSE, THANKS

  • Loading branch information...
commit abe5a2ba73ee9aadccd5595d44c717544ebce0c3 1 parent 4377a91
Anton Lavrik authored
Showing with 254 additions and 59 deletions.
  1. +178 −0 LICENSE
  2. +0 −59 README
  3. +73 −0 README.md
  4. +3 −0  THANKS
178 LICENSE
View
@@ -0,0 +1,178 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
59 README
View
@@ -1,59 +0,0 @@
-This directory contains Piqi-RPC —- an RPC-over-HTTP system for Erlang.
-
-
-Full description and documentation are available at
-
- http://piqi.org/doc/piqi-rpc
-
-
-The "examples" directory contains several examples of Piqi-RPC services
-implemented in Erlang.
-
-
-Piqi-RPC has a rebar[1] package. It is maintained in a separate GitHub
-repository:
-
- https://github.com/alavrik/piqi-rpc
-
-
-The easiest way to build and install Piqi-RPC is to use the rebar package. This
-way, all dependencies will be installed automatically.
-
-To build Piqi-RPC from sources, install the prerequisites (see below) and run
-"make" in the current directory.
-
-
-[1] Rebar is a build system for Erlang projects: https://github.com/basho/rebar
-
-
-PREREQUISITES
-=============
-
-Piqi-RPC depends on several open-source components. They need to be installed
-before building or running Piqi-RPC.
-
-
-* Webmachine
-
- HTTP library for writing well-behaving HTTP services. It works on top of
- Mochiweb.
-
- Homepage: http://webmachine.basho.com/
- Source code: http://github.com/basho/webmachine
-
-
-* Mochiweb (it is used by Webmachine)
-
- HTTP server for Erlang
-
- Source code: http://github.com/mochi/mochiweb
-
-
-The easiest and the most reliable way to install both is to download Webmachine
-and follow its installation instructions.
-
-Once installed, make sure that they are added to Erlang code paths. There are
-many ways to do that, one of them is to set the "ERL_LIBS" environment variable:
-
- export ERL_LIBS="<path-to-your-webmachine-directory>:$ERL_LIBS"
-
73 README.md
View
@@ -0,0 +1,73 @@
+Piqi-RPC is an RPC-over-HTTP system for Erlang.
+
+
+Piqi-RPC gives Erlang developers a convenient and reliable way to connect
+services written in Erlang with the rest of the world using JSON, XML or Google
+Protocol Buffers over plain HTTP.
+
+Basically, Piqi-RPC can be viewed as an HTTP gateway for Erlang functions. Any
+standard HTTP client can communicate with them not knowing anything about
+Erlang or Piqi-RPC. And the opposite is also true: Erlang functions work with
+idiomatic Erlang data structures and don’t have to be aware of HTTP or even
+Piqi-RPC.
+
+In other words, Piqi-RPC system automates several areas where Erlang developers
+usually need to write (and maintain!) a lot of boring plumbing code:
+
+**Parsing and validating input parameters** -- Piqi-RPC automatically parses
+XML, JSON, Protocol Buffers and command-line arguments, validates them and
+converts to idiomatic Erlang data structures.
+
+**Generating output parameters** -- again, Piqi-RPC automatically generates XML,
+JSON and Protocol Buffers from native Erlang representation.
+
+**HTTP communication** -- Piqi-RPC provides fully-compliant HTTP communication
+layer. It receives and validates HTTP requests, sends responses, handles
+"Content-Type" and "Accept" headers and generates around 10 different meaningful
+HTTP response types for various error conditions that can occur during request
+execution.
+
+Full description and documentation are available on the project homepage here:
+http://piqi.org/doc/piqi-rpc/
+
+
+Examples
+--------
+
+See [examples/addressbook](examples/addressbook/) and
+[examples/process_info](examples/process_info/).
+
+
+Bugs
+----
+
+Please report found problems using [GitHub
+issues](http://github.com/alavrik/piqi-rpc/issues).
+
+
+Mailing list
+------------
+
+http://groups.google.com/group/piqi
+
+
+Contributing
+------------
+
+Your contributions are always welcome. Just open a pull request.
+
+Some useful commands:
+
+ make deps # the same as "rebar get-deps"
+ make # the same as "rebar compile"
+
+ make test
+ make dialyzer
+ make -C addressbook/example all test
+
+
+License
+-------
+
+[Apache License Version 2.0](LICENSE)
+
3  THANKS
View
@@ -0,0 +1,3 @@
+The following people have contributed to piqi-rpc:
+
+Thijs Terlouw
Please sign in to comment.
Something went wrong with that request. Please try again.