| <?xml version="1.0" encoding="iso-8859-1"?> |
| <!-- |
| 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. |
| --> |
| <document xmlns="http://maven.apache.org/XDOC/2.0" |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> |
| <properties></properties> |
| <body> |
| <section name="Whirr™ API Guide"></section> |
| <p>Whirr provides a Java API for stopping and starting clusters. Please see the |
| <a href="apidocs/index.html">javadoc</a> and the unit test source code for how to achieve |
| this.</p> |
| |
| <p>The downloaded artifact contains a example project that shows how Whirr can be used |
| for various tasks .Check the <i>examples</i> subfolder.</p> |
| |
| <p>You can execute an example by running: |
| <source>$ ./bin/example [example-name]</source></p> |
| |
| </body> |
| </document> |
