Better README

fbshipit-source-id: 40b4c6d
This commit is contained in:
Brent Vatne
2016-07-25 04:59:38 +00:00
committed by Exponent GitHub Bot
parent ffb78aef77
commit 1ab774075b
2 changed files with 13 additions and 3 deletions

View File

@@ -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/)

BIN
website-screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 315 KiB