Repository: olingo-odata4-js Updated Branches: refs/heads/master 733b57dd8 -> fe2e1ae91
[OLINGO-429] add readme Project: http://git-wip-us.apache.org/repos/asf/olingo-odata4-js/repo Commit: http://git-wip-us.apache.org/repos/asf/olingo-odata4-js/commit/fe2e1ae9 Tree: http://git-wip-us.apache.org/repos/asf/olingo-odata4-js/tree/fe2e1ae9 Diff: http://git-wip-us.apache.org/repos/asf/olingo-odata4-js/diff/fe2e1ae9 Branch: refs/heads/master Commit: fe2e1ae91b03179778a83284c2c4f9fc74d4b7d6 Parents: 733b57d Author: Sven Kobler <[email protected]> Authored: Wed Sep 10 10:27:13 2014 +0200 Committer: Sven Kobler <[email protected]> Committed: Wed Sep 10 10:27:13 2014 +0200 ---------------------------------------------------------------------- odatajs/README.md | 52 ++++++++++++++++++++++++++++++++++++ odatajs/demo/tester.html | 5 ++-- odatajs/grunt-config/release.js | 6 +++-- 3 files changed, 58 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/olingo-odata4-js/blob/fe2e1ae9/odatajs/README.md ---------------------------------------------------------------------- diff --git a/odatajs/README.md b/odatajs/README.md new file mode 100644 index 0000000..0a203c0 --- /dev/null +++ b/odatajs/README.md @@ -0,0 +1,52 @@ +Title: Project build for the OData library for JavaScript +Notice: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + . + http://www.apache.org/licenses/LICENSE-2.0 + . + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +------------------------- +## **Olingo OData Client for JavaScript** + +The Olingo OData Client for JavaScript is a library written in JavaScript that +enables browser based frontend applications to easily use the OData protocol for +communication with application servers. + +This library "odatajs-4.0.0-beta-01.min.js" supports only the OData V4 protocol. +For using the OData protocols V1-V3 please refer to the [datajs library](http://datajs.codeplex.com/) + +The odatajs library can be included in any html page with the script tag (for example) + + <script type="text/javascript" src="./sources/odatajs-4.0.0-beta-01.min.js"> + </script> + +and its features can be used through the `odatajs` namespace (or window.odatajs). The odatajs library can be used together +with the datajs library which uses the `window.OData` namespace. + +For API documentation please see [ODatajs API documentation](http://olingo.apache.org/doc/javascript/apidoc/) + +You may also use the documentation and the samples from +the [datajs library](http://datajs.codeplex.com/documentation) because the features and API are similar. + + + +## Contribute to **Olingo OData Client for JavaScript** + +If you are interested to contribute to this library please have a look into +[Project setup](http://olingo.apache.org/doc/javascript/project-setup.html) and +[Build instructions](http://olingo.apache.org/doc/javascript/project-build.html) where you find a +manual how you can download the source code and build the odatajs library. + +If you intend so please also join the [Olingo developers group](http://olingo.apache.org/support.html) for discussion. + http://git-wip-us.apache.org/repos/asf/olingo-odata4-js/blob/fe2e1ae9/odatajs/demo/tester.html ---------------------------------------------------------------------- diff --git a/odatajs/demo/tester.html b/odatajs/demo/tester.html index 2658d45..55efe7f 100644 --- a/odatajs/demo/tester.html +++ b/odatajs/demo/tester.html @@ -23,7 +23,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <title>datajs startup perf test</title> <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script> - <script type="text/javascript" src="./../build/lib/odatajs-4.0.0-beta-01-RC01.js"></script> + <script type="text/javascript" src="./../build/lib/odatajs-4.0.0-beta-01-RC01.min.js"></script> <script type="text/javascript" src="./scripts/tools.js" ></script> <style type="text/css"> .code{font-family:"Courier New",monospace;font-size:13px;line-height:18px;} @@ -189,8 +189,7 @@ var metadataRequest = { headers: oHeaders, - requestUri: "https://ldcigmd.wdf.sap.corp:44355/sap/bc/ds/odata/v4/$metadata";, - //requestUri: "http://localhost:4002/tests/endpoints/FoodStoreDataServiceV4.svc/$metadata";, + requestUri: "http://localhost:4002/tests/endpoints/FoodStoreDataServiceV4.svc/$metadata";, data: null, }; http://git-wip-us.apache.org/repos/asf/olingo-odata4-js/blob/fe2e1ae9/odatajs/grunt-config/release.js ---------------------------------------------------------------------- diff --git a/odatajs/grunt-config/release.js b/odatajs/grunt-config/release.js index 3333d85..67f704f 100644 --- a/odatajs/grunt-config/release.js +++ b/odatajs/grunt-config/release.js @@ -65,7 +65,8 @@ module.exports = function(grunt) { { expand: true, cwd: 'build/lib', src: ['<%= artifactname %>*.*'], dest: './../dist/<%= artifactname %>/lib/lib', filter: 'isFile'}, { expand: true, src :'LICENSE',dest: './../dist/<%= artifactname %>/lib', filter: 'isFile' }, { expand: true, src :'NOTICE',dest: './../dist/<%= artifactname %>/lib', filter: 'isFile' }, - { expand: true, src :'DEPENDENCIES',dest: './../dist/<%= artifactname %>/lib', filter: 'isFile' } + { expand: true, src :'DEPENDENCIES',dest: './../dist/<%= artifactname %>/lib', filter: 'isFile' }, + { expand: true, src :'README.md',dest: './../dist/<%= artifactname %>/lib', filter: 'isFile' } ] }, 'release-doc' : { @@ -73,7 +74,8 @@ module.exports = function(grunt) { { expand: true, cwd: 'build/doc-src', src: ['**'], dest: './../dist/<%= artifactname %>/doc/doc', filter: 'isFile'}, { expand: true, src :'LICENSE',dest: './../dist/<%= artifactname %>/doc', filter: 'isFile' }, { expand: true, src :'NOTICE',dest: './../dist/<%= artifactname %>/doc', filter: 'isFile' }, - { expand: true, src :'DEPENDENCIES',dest: './../dist/<%= artifactname %>/doc', filter: 'isFile' } + { expand: true, src :'DEPENDENCIES',dest: './../dist/<%= artifactname %>/doc', filter: 'isFile' }, + { expand: true, src :'README.md',dest: './../dist/<%= artifactname %>/doc', filter: 'isFile' } ] }, 'release-sources' : {
