Skip to content

Commit

Permalink
chore: update README markdown for more clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
André Neves committed Feb 3, 2017
1 parent 093cf4e commit 4d86e87
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,19 @@ Utility that allows you to open other installed apps from within your React Nati
React Native macOS is a very young implementation of React Native with support for macOS systems. Because of that, the library is not yet stable. There have been no successes for real-world applications built with react-native-macos yet. Proceed at your own risk.

## Installation
Install component and save to dependencies:
```
npm i react-native-macos-app-opener --save
```

Link native modules to your project automatically with:
```
react-native-macos link
```
Or you can follow the same pattern seen in [React Native iOS Library Linking](https://facebook.github.io/react-native/docs/linking-libraries-ios.html).

## Details
The utility leverages `NSWorkspace` to launch an application passed through a parameter to `AppOpener`. If the application is already opened, the system will bring it to the front and if the application does not exist it triggers an error.
The utility leverages `NSWorkspace` to launch an application passed through a parameter to `AppOpener`. If the application is already opened, the system will bring it to the front. If the application is closed, it will launch it.

## Usage
```
Expand All @@ -20,4 +27,4 @@ AppOpener.openApp('Finder');
```

## Contribution
Please contribute! PRs are welcome and I'll do my best to extend and improve this tool. For PR management, please follow the guidelines on `CONTRIBUTING.md`.
Please contribute! PRs are welcome and I'll do my best to extend and improve this utility.

0 comments on commit 4d86e87

Please sign in to comment.