diff --git a/README.md b/README.md index 99ac543..d71502c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ -TODO: -- [ ] List all icons and their codes in documentation -- [ ] Write a proper README that explains what this is and how to use it +# @exponent/vector-icons + +This library is a compatability layer around +[@oblador/react-native-vector-icons](https://github.com/oblador/react-native-vector-icons) +to work with the Exponent asset system. If you're using React Native +without Exponent, you have no need for this library -- carry on! (or +maybe [check out Exponent](https://getexponent.com/). + +## Resources + +- [@exponent/vector-icons directory](https://exponentjs.github.io/vector-icons/) - a searchable list of all included icons. +![Screenshot of website](https://github.com/exponentjs/vector-icons/blob/master/website-screenshot.png) +- [Exponent documentation](http://docs.getexponent.com/) diff --git a/website-screenshot.png b/website-screenshot.png new file mode 100644 index 0000000..08b44f4 Binary files /dev/null and b/website-screenshot.png differ