diff --git a/README.md b/README.md index aacc663..76a4976 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,25 @@ -# proxstar +Proxstar +=========== + +Proxstar is a proxmox VM web management tool used by [Rochester Institute of Technology](https://rit.edu/)'s [Computer Science House](https://csh.rit.edu). + +## Overview + +Written using [Python](http://nodejs.org), [Flask](https://npmjs.com). + +Proxstar removes the need for CSH members to have direct access to the proxmox web interface. -Proxstar is a proxmox VM web management tool used by [Computer Science House](https://csh.rit.edu). -
-Written in Python Flask, proxstar removes the need for CSH members to have direct access to the proxmox web -interface. -
Proxstar is also used to enforce proxmox resource limits automagically. -
-Available to house members at proxstar.csh.rit.edu behind PYOIDC authentication. + +It is available to house members at [proxstar.csh.rit.edu](https://proxstar.csh.rit.edu) behind PYOIDC authentication. + +## Contributing + +1. [Fork](https://help.github.com/en/articles/fork-a-repo) this repository + - Optionally create a new [git branch](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) if your change is more than a small tweak (`git checkout -b BRANCH-NAME-HERE`) +3. Make your changes locally, commit, and push to your fork +4. Create a [Pull Request](https://help.github.com/en/articles/about-pull-requests) on this repo for our Webmasters to review + +## Questions/Concerns + +Please file an [Issue](https://github.com/ComputerScienceHouse/proxstar/issues/new) on this repository. \ No newline at end of file