updated readme

something that can be edited/used outside this repo
This commit is contained in:
Sujin/Sushi 2013-06-18 15:10:09 -04:00
parent 86ab5cc065
commit e424fbeac7

View file

@ -1,8 +1,34 @@
OpenPhoto / Documentation Trovebox / Documentation
======================= =======================
You can find the documentation at http://theopenphotoproject.org/documentation. It's a mirror of what is here but easier to follow. Whether youre looking to install Trovebox yourself or build something with our API, youre in the right place.
If you'd like to contribute to the documentation, please do! We welcome any and all contributions. Fork this repository (documentation) and add your contribution, then send a pull request. The docs/contribute/documentation.markdown in this repository explains everything you need to more. ### What youll find here
Questions? We're here to help. Email our mailing list at openphoto@googlegroups.com or ask in #openphoto on Freenode. #### Guides
Our guides walk you through installing Trovebox Community Edition.
#### API
The Trovebox API makes it easy for you to read and write data from your Trovebox site as well as creating Trovebox clients.
#### Libraries
Troveboxs language libraries make getting started with our API even easier. Download one of our language libraries, get to know it by reading its documentation, and start hacking.
#### Plugins
Trovebox comes with a set of plugins you can enable. The plugins section will eventually provide documentation for these plugins as well as how to write your own. Bug someone to write this.
### Contributing
The main Trovebox code is released under an open source license, so you can fork the code, install it yourself, and modify the code. If youre interested in contributing your modified code back to our codebase, our contributors section tells you everything you need to know.
### Found a bug?
We track our bugs in Github, and we welcome all bug reports, no matter how small.
### Questions?
If you have any questions, were here to help. Email our mailing list at openphoto@googlegroups.com or ask in #openphoto on Freenode.