Skip to content

Commit

Permalink
chore: cleanup & prep for 6.0.0 release (#874)
Browse files Browse the repository at this point in the history
* chore(package): use short notation for repo and bugs url
* chore(package-lock): rebuilt
* doc(README): update format, links, etc
  • Loading branch information
erisu authored May 28, 2020
1 parent 41459f0 commit 970c843
Show file tree
Hide file tree
Showing 3 changed files with 134 additions and 135 deletions.
54 changes: 29 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# "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
# https://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
Expand All @@ -19,44 +19,48 @@
#
-->

[![Build status](https://ci.appveyor.com/api/projects/status/github/apache/cordova-ios?branch=master)](https://ci.appveyor.com/project/Humbedooh/cordova-ios)
[![Build Status](https://travis-ci.org/apache/cordova-ios.svg?branch=master)](https://travis-ci.org/apache/cordova-ios)
# Cordova iOS

[![NPM](https://nodei.co/npm/cordova-ios.png)](https://nodei.co/npm/cordova-ios/)

[![Node CI](https://github.com/apache/cordova-ios/workflows/Node%20CI/badge.svg?branch=master)](https://github.com/apache/cordova-ios/actions?query=branch%3Amaster)
[![codecov.io](https://codecov.io/github/apache/cordova-ios/coverage.svg?branch=master)](https://codecov.io/github/apache/cordova-ios?branch=master)

Cordova iOS
=============================================================
Cordova iOS is an iOS application library that allows for Cordova-based projects to be built for the iOS Platform. Cordova based applications are, at the core, applications written with web technology: HTML, CSS and JavaScript.

<a href="http://cordova.apache.org">Apache Cordova</a> is a project of <a href="http://apache.org">The Apache Software Foundation (ASF)</a>.
[Apache Cordova](https://cordova.apache.org/) is a project of [The Apache Software Foundation (ASF)](https://apache.org/).

Requires:
## Requirements

* Xcode 9.x (deprecated), 10, or greater. Download it at [http://developer.apple.com/downloads](http://developer.apple.com/downloads) or the [Mac App Store](http://itunes.apple.com/us/app/xcode/id497799835?mt=12).
* [node.js](https://nodejs.org)
* Xcode 11.x or greater. Download it at the [Apple Developer - Downloads](https://developer.apple.com/downloads) or the [Mac App Store](https://apps.apple.com/us/app/xcode/id497799835?mt=12).
* [Node.js](https://nodejs.org)

Create a Cordova project
-------------------------------------------------------------
## Create a Cordova project

Follow the instructions in the [**Command-Line Usage** section](http://cordova.apache.org/docs/en/edge/guide_cli_index.md.html#The%20Command-line%20Interface) of [http://docs.cordova.io](http://docs.cordova.io)
Follow the instructions in the [**Command-Line Usage** section](https://cordova.apache.org/docs/en/edge/guide_cli_index.md.html#The%20Command-line%20Interface) of [Apache Cordova Docs](https://cordova.apache.org/docs/en/latest/)

To use a **shared CordovaLib**, for example in development, link the appropriate cordova-ios platform folder path:

cordova platform add --link /path/to/cordova-ios
```bash
cordova platform add --link /path/to/cordova-ios
```

## Updating a Cordova project

Updating a Cordova project
-------------------------------------------------------------
When you install a new `cordova-cli` version that comes with a new iOS platform version, from within your project:

When you install a new cordova-cli version that comes with a new iOS platform version, from within your project:
```bash
cordova platform rm ios
cordova platform add ios
```

cordova platform rm ios
cordova platform add ios
## How to Test Repo Development

Tests
--------------------------------------------------------------------
```bash
npm install
npm test
```

1. Run `npm install`
2. Run `npm test`
## Futher reading

Futher reading
-----
* [http://cordova.apache.org/](http://cordova.apache.org/)
* [https://cordova.apache.org/](https://cordova.apache.org/)
206 changes: 103 additions & 103 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 970c843

Please sign in to comment.