Author: vsiveton
Date: Thu Apr 30 12:51:23 2009
New Revision: 770209
URL: http://svn.apache.org/viewvc?rev=770209&view=rev
Log:
o improved README, NOTICE and LICENSE
Added:
incubator/shindig/branches/1.0.x-incubating/java/LICENSE
incubator/shindig/branches/1.0.x-incubating/java/NOTICE
- copied, changed from r770145, incubator/shindig/branches/
1.0.x-incubating/NOTICE
incubator/shindig/branches/1.0.x-incubating/php/LICENSE
- copied unchanged from r770160, incubator/shindig/branches/
1.0.x-incubating/LICENSE
incubator/shindig/branches/1.0.x-incubating/php/NOTICE
- copied, changed from r770145, incubator/shindig/branches/
1.0.x-incubating/NOTICE
Removed:
incubator/shindig/branches/1.0.x-incubating/LICENSE
incubator/shindig/branches/1.0.x-incubating/NOTICE
incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
assembly/binary-src/
Modified:
incubator/shindig/branches/1.0.x-incubating/README
incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
assembly/java.xml
incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
assembly/php.xml
incubator/shindig/branches/1.0.x-incubating/features/README
incubator/shindig/branches/1.0.x-incubating/java/README
incubator/shindig/branches/1.0.x-incubating/javascript/README
incubator/shindig/branches/1.0.x-incubating/php/README
Modified: incubator/shindig/branches/1.0.x-incubating/README
URL:
http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/README?rev=770209&r1=770208&r2=770209&view=diff
===
===
===
=====================================================================
--- incubator/shindig/branches/1.0.x-incubating/README (original)
+++ incubator/shindig/branches/1.0.x-incubating/README Thu Apr 30
12:51:23 2009
@@ -1,14 +1,38 @@
-Welcome to Apache Shindig!
+ Apache Shindig
-* Read java/README for instructions on using the java gadget servers.
+ What is it?
+ -----------
-* To build and run the Java server see BUILD-JAVA
+ Shindig is a JavaScript container and implementations of the
backend APIs
+ and proxy required for hosting OpenSocial applications.
-* Read php/README for instructions on how to run a php gadget server
- instead of a java gadget server.
+ Documentation
+ -------------
-* Read javascript/README for instructions for using the Shindig
Gadget
- Container JavaScript to enable your page to render Gadgets using
- gmodules.com or a server started up as described above.
+ The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
.
-For more information, see http://incubator.apache.org/shindig/
+ Read BUILD-JAVA for instructions on how to build and run the Java
server.
+
+ Read java/README for instructions on how to run a Java gadget
server.
+
+ Read php/README for instructions on how to run a php gadget server.
+
+ Read javascript/README for instructions for using the Shindig
Gadget Container
+ JavaScript to enable your page to render Gadgets.
+
+ Read features/README for instructions on how to use features.
+
+ Licensing
+ ---------
+
+ Please see the file called LICENSE in the java and php directories.
+
+ Shindig URLS
+ ------------
+
+ Home Page: http://incubator.apache.org/shindig/
+ Downloads: http://incubator.apache.org/shindig/download/index.html
+ Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
+ Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
+ Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
+ Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/
main/assembly/java.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml?rev=770209&r1=770208&r2=770209&view=diff
===
===
===
=====================================================================
--- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
assembly/java.xml (original)
+++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
assembly/java.xml Thu Apr 30 12:51:23 2009
@@ -43,18 +43,21 @@
<outputDirectory>shindig-${pom.version}-java</outputDirectory>
<directory>../</directory>
<includes>
- <include>COMMITTERS</include>
<include>DISCLAIMER</include>
- <include>LICENSE</include>
- <include>NOTICE</include>
</includes>
+ <excludes>
+ <exclude>LICENSE</exclude>
+ <exclude>NOTICE</exclude>
+ <exclude>README</exclude>
+ </excludes>
</fileSet>
<fileSet>
<outputDirectory>shindig-${pom.version}-java</outputDirectory>
- <directory>src/main/assembly/binary-src/</directory>
- <filtered>true</filtered>
+ <directory>../java</directory>
<includes>
- <include>**/*</include>
+ <include>LICENSE</include>
+ <include>NOTICE</include>
+ <include>README</include>
</includes>
</fileSet>
</fileSets>
Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/
main/assembly/php.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml?rev=770209&r1=770208&r2=770209&view=diff
===
===
===
=====================================================================
--- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
assembly/php.xml (original)
+++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
assembly/php.xml Thu Apr 30 12:51:23 2009
@@ -32,10 +32,7 @@
<include>features/**</include>
<include>javascript/**</include>
<include>config/**</include>
- <include>COMMITTERS</include>
<include>DISCLAIMER</include>
- <include>LICENSE</include>
- <include>NOTICE</include>
</includes>
<excludes>
<exclude>site/**</exclude>
@@ -63,6 +60,8 @@
<!-- misc -->
<exclude>*.patch</exclude>
<exclude>*.diff</exclude>
+ <exclude>LICENSE</exclude>
+ <exclude>NOTICE</exclude>
<exclude>README</exclude>
</excludes>
<lineEnding>unix</lineEnding>
Modified: incubator/shindig/branches/1.0.x-incubating/features/README
URL:
http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/features/README?rev=770209&r1=770208&r2=770209&view=diff
===
===
===
=====================================================================
--- incubator/shindig/branches/1.0.x-incubating/features/README
(original)
+++ incubator/shindig/branches/1.0.x-incubating/features/README Thu
Apr 30 12:51:23 2009
@@ -1,40 +1,68 @@
-You can automatically include new features into your shindig server
by adding
-them to this directory. Features should exist in a self-contained
directory
-with the following structure:
-
-features
- |_your-feature-name
- |_feature.xml
- |_code-to-run-inside-gadget.js
- |_code-to-run-inside-container.js
-
-The structure of feature.xml is as follows:
-TODO: link to xml schema for feature.xml
-
-<?xml version="1.0"?>
-<feature>
- <name>your-feature-name (required)</name>
- <dependency>any dependency you have (optional, may have
multiple)</dependency>
- <gadget> (optional)
- <script src="code-to-run-inside-gadget.js"/> (optional, may
have multiple,
- may use web resources as well but we strongly encourage
bundling your
- javascript with the xml)
- </gadget>
- <container> (optional)
- <script src="code-to-run-inside-container.js"> (same as for
<gadget>)
- </container>
-</feature>
-
-Please always make sure that all files you provide are encoded as
utf8.
-
-When adding new features, your javascript should conform to shindig
javascript
-coding conventions. This means that you should not be producing new
globals and
-your feature should be compatible with Caja.
+ Apache Shindig Features
-When committing a new feature, you should update the features.txt
file by
-running the following script in a unix-like environment:
+ What is it?
+ -----------
-ls -R1a features/**/*.xml > features/features.txt
+ Shindig is a JavaScript container and implementations of the
backend APIs
+ and proxy required for hosting OpenSocial applications.
-TODO: Instructions for regenerating features.txt for other
operating system
-environments.
+ This is the features component of Shindig.
+
+ Documentation
+ -------------
+
+ The most up-to-date documentation can be found at
http://incubator.apache.org/shindig/
+
+ Using features
+ --------------
+
+ You can automatically include new features into your shindig
server by adding
+ them to this directory. Features should exist in a self-contained
directory
+ with the following structure:
+
+ features
+ |_your-feature-name
+ |_feature.xml
+ |_code-to-run-inside-gadget.js
+ |_code-to-run-inside-container.js
+
+ The structure of feature.xml is as follows:
+ TODO: link to xml schema for feature.xml
+
+ <?xml version="1.0"?>
+ <feature>
+ <name>your-feature-name (required)</name>
+ <dependency>any dependency you have (optional, may have
multiple)</dependency>
+ <gadget> (optional)
+ <script src="code-to-run-inside-gadget.js"/> (optional, may
have multiple,
+ may use web resources as well but we strongly encourage
bundling your
+ javascript with the xml)
+ </gadget>
+ <container> (optional)
+ <script src="code-to-run-inside-container.js"> (same as for
<gadget>)
+ </container>
+ </feature>
+
+ Please always make sure that all files you provide are encoded as
utf8.
+
+ When adding new features, your javascript should conform to
shindig javascript
+ coding conventions. This means that you should not be producing
new globals and
+ your feature should be compatible with Caja.
+
+ When committing a new feature, you should update the features.txt
file by
+ running the following script in a unix-like environment:
+
+ ls -R1a features/**/*.xml > features/features.txt
+
+ TODO: Instructions for regenerating features.txt for other
operating system
+ environments.
+
+ Shindig URLS
+ ------------
+
+ Home Page: http://incubator.apache.org/shindig/
+ Downloads: http://incubator.apache.org/shindig/download/index.html
+ Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
+ Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
+ Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
+ Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
Added: incubator/shindig/branches/1.0.x-incubating/java/LICENSE
URL:
http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/LICENSE?rev=770209&view=auto
===
===
===
=====================================================================
--- incubator/shindig/branches/1.0.x-incubating/java/LICENSE (added)
+++ incubator/shindig/branches/1.0.x-incubating/java/LICENSE Thu Apr
30 12:51:23 2009
@@ -0,0 +1,212 @@
+
+ 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
