Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Update url_launcher README #4

Merged
merged 3 commits into from
Apr 21, 2017
Merged

Update url_launcher README #4

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2077c2d
update README
szakarias Apr 21, 2017
5637b25
remove empty lines
szakarias Apr 21, 2017
f77111f
Address comments
szakarias Apr 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 44 additions & 3 deletions packages/url-launcher/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,48 @@
# url_launcher

A Flutter plugin for launching a URL.
A Flutter plugin for launching a URL in the mobile platform. Supports iOS and Android.

## Getting Started
## Usage

Try out the plugin by running the project in the example/ folder.
Get this plugin as described [here] (https://www.dartlang.org/tools/pub/get-started).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd replace this line with:

To use this plugin, add url_launcher as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).


### Example

``` dart
import 'package:flutter/material.dart';
import 'package:url_launcher/url_launcher.dart';

void main() {
runApp(new Scaffold(
body: new Center(
child: new RaisedButton(
onPressed: launchURL,
child: new Text('Show Flutter homepage'),
),
),
));
}

launchURL() {
UrlLauncher.launch('https://flutter.io');
}

```

## Supported URL schemes

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe start with: 'The launch method takes a string argument containing a URL. This URL can formatted using a number of different URL schemes.'

The supported URL schemes depend on the underlying platform and installed system apps.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think only system apps can handle URLs, so suggest just saying 'installed apps'.


Common schemes supported by both iOS and Android:

* http:<URL> , https:<URL>
* mailto:<email-address>
* tel:<phone-number>
* sms:<phone-number>

More details can be found here for [iOS](https://developer.apple.com/library/content/featuredarticles/iPhoneURLScheme_Reference/Introduction/Introduction.html) or [Android](https://developer.android.com/guide/components/intents-common.html)


## More info
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can omit this section as the top usage line I suggested has the same link in it.


For more info on Flutter plugins see [this guide](https://flutter.io/platform-plugins/)