deprecation notice
[cordova-firefoxos.git] / README.md
index eee38b8611e93ca7add602144a373e1bbf343a7f..2f8f68545d46074d4280f15430821b437e9d48fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,48 @@
-# Cordova Laboratory
+<!--
+#
+# 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.
+#
+-->
+Cordova Firefox OS (Boot 2 Gecko)
+==============================
 
 
-> Caution: Safety Goggles are Recommended!
+---
+📌 **Deprecation Notice**
 
 
-## Purpose
+This repository is deprecated and no more work will be done on this by Apache Cordova. You can continue to use this and it should work as-is but any future issues will not be fixed by the Cordova community.
 
 
-The purpose of this repo is for experimental code. Examples include demo apps,
-native api explorations, or anything really that does not fit in an existing Cordova platform.
+Feel free to fork this repository and improve your fork. Existing forks are listed in [Network](../../network) and [Forks](../../network/members).
 
 
-## Good Karma
+- Learn more: https://github.com/apache/cordova/blob/master/deprecated.md#deprecated-platforms
+---
 
 
-Each project should prefix the commits with the project name (or shortered name).
-This allows us to easy associate each commit with a project.
+Introduction
+------------
 
 
-For example, the project `./cordova-hello-world`:
+[Firefox OS](http://www.mozilla.org/en-US/firefox/os/) is an open source operating system for smartphones and tablet computers being developed by Mozilla. It is designed to allow HTML5 applications to integrate directly with the device's hardware using JavaScript.
 
 
-    git commit -m "[hello-world] Add an amazing feature."
+cordova-firefoxos allows developers to use the cross platform APIs in Cordova to target the Firefox OS. Most APIs are just proxied to the matching Firefox OS API calls.
+
+Prerequisties
+==============
+
+There are no prerequisites for adding Firefox OS as a Cordova platform. For usage, setting up debugging environment and running on the device, see the [Cordova support for Firefox OS](https://developer.mozilla.org/en-US/Apps/Tools_and_frameworks/Cordova_support_for_Firefox_OS) page on Mozilla Developer Network.
+
+For platform development information, check out the [Firefox OS cordova development page](http://mozilla-cordova.github.io)
+
+A lot of good documentation on Firefox OS development is also available on the [Mozilla Developer Network](https://developer.mozilla.org/en/docs/Mozilla/Firefox_OS).