add README

This commit is contained in:
Bailey Ling 2016-01-27 23:03:03 -05:00
parent 9f9b162025
commit 78c4dcc36c

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# vim-airline-themes
This is the official theme repository for [vim-airline](https://github.com/vim-airline/vim-airline).
# Contribution Guidelines
## New themes
* Pull requests for new themes are welcome. Please be sure to include a screenshot. You can paste an image into issue [#1](https://github.com/vim-airline/vim-airline-themes/issues/1), and then editing the post to reveal the uploaded image URL.
## Modifications to existing themes
* Themes are subjective, so if you are going to make modifications to an existing theme, please expose a configurable variable to allow users to choose how the theme will react.
# Screenshots
Screenshots are in the process of being migrated here. In the meantime you can find screenshots in the existing repository's [Wiki](https://github.com/vim-airline/vim-airline/wiki/Screenshots).
# Maintenance
If you are interested in becoming the official maintainer of this project, please contact [**@bling**][1], [**@chrisbra**][2], or [**@mhartington**][3].
# License
MIT License. Copyright (c) 2013-2016 Bailey Ling & Contributors.
[1]: https://github.com/bling
[2]: https://github.com/chrisbra
[3]: https://github.com/mhartington