Skip to content

Commit

Permalink
add: documentation readme
Browse files Browse the repository at this point in the history
  • Loading branch information
puguhsudarma committed Jul 30, 2023
1 parent 65ba437 commit e7292b2
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# expo-chucker

Chucker wrapper in expo react native
Chucker is a library to inspect HTTP requests/responses on your Android device. https://github.com/ChuckerTeam/chucker

### Add the package to your npm dependencies

```bash
npm install expo-chucker

```

or

```bash
yarn add expo-chucker

```

### Add the expo plugin to your app

Add the plugin to your `app.json` / `app.config.ts` file.

```js
...
plugins: [
'expo-chucker'
],

```

If you want to disabled the plugin in production, you can use the props `enabled: boolean` in the plugin configuration.

```js
plugins: [
['expo-chucker', { enabled: package === 'staging' }]
],
```

# Contributing

Contributions are very welcome! Please refer to guidelines described in the [contributing guide](https://github.com/expo/expo#contributing).

0 comments on commit e7292b2

Please sign in to comment.