You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ja...@apache.org on 2018/09/03 14:12:32 UTC
[cordova-test-platform] branch master updated: CB-11347: a bit more
documentation around platform API and additional reading. (#2)
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cordova-test-platform.git
The following commit(s) were added to refs/heads/master by this push:
new 147299a CB-11347: a bit more documentation around platform API and additional reading. (#2)
147299a is described below
commit 147299a504a52773854cecd0b7b96aee4829d725
Author: Fil Maj <ma...@gmail.com>
AuthorDate: Mon Sep 3 09:12:30 2018 -0500
CB-11347: a bit more documentation around platform API and additional reading. (#2)
---
README.md | 19 ++++++++++++++++---
1 file changed, 16 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index afaf50d..efc10c0 100644
--- a/README.md
+++ b/README.md
@@ -21,14 +21,27 @@
# cordova-test-platform
-This repo contains the code for an [Apache Cordova](http://cordova.apache.org) platform that allows you to build applications that target NOTHING. This platform is purely for testing, although it is also a good resource to see the minimum requirements to implement a new platform.
-
+This repo contains the code for an [Apache Cordova](http://cordova.apache.org)
+platform that allows you to build applications that target NOTHING. This
+platform is purely for testing, although it is also a good resource to see the
+minimum requirements to implement a new platform.
[Apache Cordova](http://cordova.apache.org) is a project of [The Apache Software Foundation (ASF)](http://apache.org)
+# How to Use This
+
+This repository contains a reference implementation of Cordova's Platform API.
+The Platform API defines interfaces for Cordova tooling to be able to create,
+build/compile, run/emulate and clean Cordova projects targeted at a specific
+platform. Core Cordova platforms such as cordova-android and cordova-ios
+implement this API. This API is then used by tools such as cordova-cli and
+cordova-lib when managing platform-specific actions in cross-platform Cordova
+projects.
# Report Issues
Report them at the [Apache Cordova Issue Tracker](https://issues.apache.org/jira/browse/CB).
# Further Reading
-- [Apache Cordova Documentation](http://docs.cordova.io)
\ No newline at end of file
+- [Apache Cordova Documentation](http://docs.cordova.io)
+- https://github.com/cordova/cordova-discuss/pull/9
+- https://github.com/cordova/cordova-discuss/pull/12
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org