Significant upgrade to Brooklyn's Readme.
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-server/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-server/commit/d15890a5 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-server/tree/d15890a5 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-server/diff/d15890a5 Branch: refs/heads/0.5.0 Commit: d15890a539932eeb367176056ec49d63908ee8c4 Parents: 589bd26 Author: David Toy <[email protected]> Authored: Fri Apr 12 14:20:11 2013 +0100 Committer: David Toy <[email protected]> Committed: Mon Apr 22 12:52:47 2013 +0100 ---------------------------------------------------------------------- README.md | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-server/blob/d15890a5/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..81a1a7a --- /dev/null +++ b/README.md @@ -0,0 +1,75 @@ + + +# [Brooklyn 0.6.0-SNAPSHOT](http://brooklyncentral.github.com) <!-- BROOKLYN_VERSION --> + +Brooklyn is a library and control plane for deploying and managing distributed applications. + +See [brooklyncentral.github.com](http://brooklyncentral.github.com) for details and examples. + +## What? + +Brooklyn is a management tool for applications hosted in one or more clouds (or other locations). + + +## Quick Start + +Three quick start options are available: + +* [Getting started guide](http://brooklyncentral.github.io/use/guide/quickstart/index.html) +* [Download the latest release](https://github.com/brooklyncentral/brooklyn/tarball/master). +* Clone the repo: `git clone git://github.com/brooklyncentral/brooklyn.git`. + +## Versioning + +For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Brooklyn will be maintained under the [Semantic Versioning guidelines](http://semver.org/). + +Releases will be numbered with the following format: + +`<major>.<minor>.<patch>` + +And constructed with the following guidelines: + +* Breaking backward compatibility bumps the major (and resets the minor and patch) +* New additions without breaking backward compatibility bumps the minor (and resets the patch) +* Bug fixes and misc changes bumps the patch + +Milestone (`<major>.<minor>.<patch>-M<milestone>`) and Release Candidate (`<major>.<minor>.<patch>-rc.<candidate>`) are used in the release process. + +## Bug Tracker + +Have a bug or a feature request? [Please open a new issue](https://github.com/brooklyncentral/brooklyn/issues). + +## Community + +Keep track of development and community news. + +* Follow [@brooklyncentral on Twitter](http://twitter.com/brooklyncentral). +* Have a question that's not a feature request or bug report? [Ask on the mailing list.](http://groups.google.com/group/brooklyn-dev) +* Chat with us over IRC. On the `irc.freenode.net` server, in the `#brooklyncentral` channel. + +## Contributing + +Your input will be welcomed. + +See the [full guide to contributing](http://brooklyncentral.github.com/dev/how-to-contrib.html) on brooklyncentral.github.com. + +Thanks! + + +## Copyright and License + +Copyright 2013 Cloudsoft Corporation, ltd. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this work except in compliance with the License. +You may obtain a copy of the License in the LICENSE file, or at: + + [http://www.apache.org/licenses/LICENSE-2.0](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. + +brooklyn is a registered trademark of Cloudsoft Corporation.
