Skip to content

Commit fc03d63

Browse files
committed
Fix .npmignore and add peer dependency requirement
1 parent 3410e96 commit fc03d63

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

.npmignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# Ignore source code
1+
# Ignore source code (but don't ignore TypeScript declaration files)
22
**/*.ts
33
**/*.tsx
4+
!*.d.ts
45

56
# gitHub actions
67
.github
@@ -135,3 +136,4 @@ dist
135136

136137
# Jest
137138
jest.config.js
139+
__mocks__/

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010
* React Native
1111
* Recoil
1212

13+
## Installation
14+
15+
Make sure you install `react-native-flipper` as well as this client.
16+
1317
## Usage
1418

1519
Add this client to your React Native project by mounting it within your App JSX tree anywhere, but ideally immediately inside RecoilRoot.

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "0.0.1",
44
"description": "A Flipper client for React Native meant to provide Recoil state information to a Flipper desktop client.",
55
"main": "index.js",
6+
"types": "index.d.ts",
67
"scripts": {
78
"build": "npx tsc --declaration",
89
"lint": "eslint",
@@ -39,5 +40,8 @@
3940
"react-native": "^0.64.2",
4041
"react-native-flipper": "^0.102.0",
4142
"recoil": "^0.3.1"
43+
},
44+
"peerDependencies": {
45+
"react-native-flipper": "^0.102.0"
4246
}
4347
}

0 commit comments

Comments
 (0)