From 42e9d2118dc2ec8945e88c9a003956a8259ad867 Mon Sep 17 00:00:00 2001 From: Florian Mauracher Date: Sun, 10 Jan 2021 14:48:57 +0100 Subject: [PATCH] Update readme --- LICENSE.md | 18 ------------------ README.md | 27 ++++++++++++--------------- lib/copyright-header.js | 4 ++-- 3 files changed, 14 insertions(+), 35 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index cedf8c6..343348b 100755 --- a/LICENSE.md +++ b/LICENSE.md @@ -8,21 +8,3 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use 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. - -Third-Party Code -================ - -cesium-sensor-volumes includes the following third-party code. - -### almond - -https://github.com/jrburke/almond - -> Copyright (c) 2010-2011, The Dojo Foundation -> -> 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 702ae10..367b594 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,22 @@ -# [cesium](https://cesiumjs.org)-sensor-volumes -[![Build Status](https://travis-ci.org/jlouns/cesium-sensor-volumes.svg?branch=master)](https://travis-ci.org/jlouns/cesium-sensor-volumes)  -[![npm version](https://badge.fury.io/js/cesium-sensor-volumes.svg)](https://badge.fury.io/js/cesium-sensor-volumes) -[![Dependency Status](https://david-dm.org/jlouns/cesium-sensor-volumes.svg)](https://david-dm.org/jlouns/cesium-sensor-volumes) +# [cesium](https://cesium.com/cesiumjs/)-sensor-volumes [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) A Cesium plugin for visualizing sensor volumes. Based on [cesium-sensors](https://github.com/AnalyticalGraphicsInc/cesium-sensors) and evolved to support more recent Cesium versions. ## Install -```sh -$ npm install --save cesium-sensor-volumes -``` +This version isn't installable from npm as it is a customized version. ## Usage -Prebuilt minified and unminified versions of the plugin are in the [dist](dist/) directory. Include the `cesium-sensor-volumes.js` file using a `script` tag after the `Cesium.js` `script` tag. +Prebuilt minified and unminified versions of the plugin are in the [dist](dist/) directory. +Include the `cesium-sensor-volumes.js` file using a `script` tag after the `Cesium.js` `script` tag. -The plugin automatically adds support for the CZML properties `agi_conicSensor`, `agi_customPatternSensor`, and `agi_rectangularSensor`. The corresponding `Entity` properties are `conicSensor`, `customPatternSensor`, and `rectangularSensor`. +The plugin automatically adds support for the CZML properties `agi_conicSensor`, `agi_customPatternSensor`, and `agi_rectangularSensor`. +The corresponding `Entity` properties are `conicSensor`, `customPatternSensor`, and `rectangularSensor`. -In order to load data directly into `Entity` objects that you create directly, you must call `entity.addProperty` to create each of the sensor properties you wish to use. The CZML processing does this automatically. +In order to load data directly into `Entity` objects that you create directly, you must call `entity.addProperty` to create each of the sensor properties you wish to use. +The CZML processing does this automatically. ```html @@ -26,12 +24,10 @@ In order to load data directly into `Entity` objects that you create directly, y @@ -39,7 +35,8 @@ entity.conicSensor.intersectionColor = new Cesium.ConstantProperty(new Cesium.Co ### Examples -Simple examples are included in the [examples](examples/) folder. To run locally, run `npm start` and navigate to [http://localhost:3000](http://localhost:3000) and select the example application to run. +Simple examples are included in the [examples](examples/) folder. +To run locally, run `npm start` and navigate to [http://localhost:3000](http://localhost:3000) and select the example application to run. ## Build diff --git a/lib/copyright-header.js b/lib/copyright-header.js index e9d4504..a53b284 100755 --- a/lib/copyright-header.js +++ b/lib/copyright-header.js @@ -1,5 +1,5 @@ /** - * Cesium Sensor Volumes - https://github.com/jlouns/cesium-sensor-volumes + * Cesium Sensor Volumes - https://github.com/Flowm/cesium-sensor-volumes * * Copyright 2016 Jonathan Lounsbury * Copyright 2011-2014 Analytical Graphics Inc. and Cesium Contributors @@ -17,7 +17,7 @@ * limitations under the License. * * Portions licensed separately. - * See https://github.com/jlouns/cesium-sensor-volumes/blob/master/LICENSE.md for full licensing details. + * See https://github.com/Flowm/cesium-sensor-volumes/blob/master/LICENSE.md for full licensing details. * * Derived from Cesium Sensors - https://github.com/AnalyticalGraphicsInc/cesium-sensors */