diff --git a/README.md b/README.md
index 8bde17e..8c3e94a 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
This library is a compatibility layer around [@oblador/react-native-vector-icons](https://github.com/oblador/react-native-vector-icons) to work with the Expo asset system. If you're using React Native without Expo, you have no need for this library -- carry on! (or maybe [check out Expo](https://expo.io/)).
-> 👀: this library does *not* provide access to react-native-vector-icon's `Icon.getImageSource()` function for generating images from icons at runtime ([for context on why, see this issue](https://github.com/expo/vector-icons/issues/26)). If you find yourself needing an icon in the form of an image rather than text, you should generate that image yourself and bundle it with your app.
+> 👀: this library does _not_ provide access to react-native-vector-icon's `Icon.getImageSource()` function for generating images from icons at runtime ([for context on why, see this issue](https://github.com/expo/vector-icons/issues/26)). If you find yourself needing an icon in the form of an image rather than text, you should generate that image yourself and bundle it with your app.
## Resources
@@ -17,11 +17,11 @@ This library is part of the `expo` package, so if you are using `expo` you can s
```tsx
import React from 'react';
-import { Ionicons } from '@expo/vector-icons';
+import Ionicons from '@expo/vector-icons/Ionicons';
export default class IconExample extends React.Component {
render() {
- return ;
+ return ;
}
}
```
@@ -38,17 +38,21 @@ I'll be honest with you, it's not straightforward. You should set aside about an
2. Copy files from the cloned directory into `src/vendor/react-native-vector-icons`, except the dotfiles.
3. Run `git status` and look at the untracked files. Remove anything that doesn't seem needed. For example, remove package.json, react-native.config.js, react-native.osx.js. Things to look out for are new icon fonts or new `create-*` files.
4. Run `git diff **/*.js` - do any of the changes look like they should be synced over to the equivalent `.ts` files in `src`?/
- - ToolBarAndroid and TabBarIOS are not included in @expo/vector-icons
- - Neither are the native vendor font loading or image source related methods.
- - Probably there won't be anything important. The main thing to look out for are user-facing API changes, the `@expo/vector-icons` internals are different enough that you don't need to worry about it.
- - Were any dependencies added? Check imports against those in the current package.json, see why they were added - maybe they support the `bin` scripts, in which case we need them.
- - TypeScript/Flow types for Icon/Icon.Button components may need to be updated.
+
+- ToolBarAndroid and TabBarIOS are not included in @expo/vector-icons
+- Neither are the native vendor font loading or image source related methods.
+- Probably there won't be anything important. The main thing to look out for are user-facing API changes, the `@expo/vector-icons` internals are different enough that you don't need to worry about it.
+- Were any dependencies added? Check imports against those in the current package.json, see why they were added - maybe they support the `bin` scripts, in which case we need them.
+- TypeScript/Flow types for Icon/Icon.Button components may need to be updated.
+
5. Run `yarn` when you're done and it'll copy vendor files over to build.
6. Go to the website directory, test it out by changing the `@expo/vector-icons` version to `"../"` (TODO: investigate this quirk!). If new icons were added, ensure that they work here.
- - While you're here, it would be kind of you to update the Expo SDK version to latest.
+
+- While you're here, it would be kind of you to update the Expo SDK version to latest.
+
7. Publish an alpha release, switch back the version in the website to that version.
8. Open a PR, have someone else like @brentvatne look at it. If it's good to go, publish the final version, update the website version again, then merge. The website will be deployed when you merge to master.
### How to deploy the website
-Create a commit on master.
\ No newline at end of file
+Create a commit on master.