Skip to content

chore: Update README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 18, 2020
Merged

chore: Update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 18 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,36 @@ yarn add -D react-native-owl
npm install -D react-native-owl
```

## Configuration file

The config file - which unless specified in the cli should live in `./owl.config.json` - is used to descript how Owl should run your app and your tests. Below you can find all the options the can be specified.

| Name | Required | Description |
| ------------------ | -------- | ------------------------------------------------------------ |
| **ios config** | | |
| `ios.workspace` | true | Path to the `.xcworkspace` file of your react-native project |
| **android config** | | |
| - | | |

## CLI

### Building the app

##### Options

| Name | Required | Choices | Description |
| ---------- | -------- | --------------- | ---------------------------------------- |
| `platform` | true | `ios`,`android` | The platform the app should be built on. |
| Name | Required | Default | Choices | Description |
| ---------- | -------- | ----------------- | --------------- | --------------------------------------- |
| `config` | false | ./owl.config.json | - | Path to the configuration file |
| `platform` | true | - | `ios`,`android` | The platform the app should be built on |

```bash
owl build --platform ios
```
owl build --platform ios --config ./owl.config.json
```

### Running the tests

```
owl test --platform ios
owl test --platform ios --config ./owl.config.json
```

[github-image]: https://github.com/FormidableLabs/react-native-owl/workflows/Run%20Tests/badge.svg
Expand Down