Edited README with more fields added. Simply added some texts in each field. Examples are given in Installation, Usage, and references. Using Markdown as format of README file.

This commit is contained in:
sliang17 2019-03-12 10:39:35 -07:00
parent 1ebd953057
commit d034bd6c21

View file

@ -1,7 +1,83 @@
# Reimbursinator
Reimbursinator is a web application that dealing with reimbursements.
## Description / About the project
Reimbursinator was developed by students at Portland State University with the sponsorship of Software Freedom Conservancy as an open source expense management solution with customizable policy rules. The front end is written in Javascript, with a back end API served by Django.
Developed by: Daniel Dupriest, Logan Miller, Jack, Joe Arriaga, Preston, Rupika, Liang Shuaiyi
## Basic Features
Licensed under GNU Affero General Public License v3.0
1.FeatureOne
⋅⋅⋅ Explanation
2.FeatureTwo
⋅⋅⋅ Explanation
3.FeatureThree
## Installation
(Demo)
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.
```bash
pip install foobar
```
## Infrastructure of Reimbursinator
Tree structure (image of structure)
## Usage
(Demo)
```python
import foobar
foobar.pluralize('word') # returns 'words'
foobar.pluralize('goose') # returns 'geese'
foobar.singularize('phenomena') # returns 'phenomenon'
```
## Contributing
Developed by: Daniel Dupriest, Logan Miller, Jack, Joe Arriaga, Preston, Rupika, Shuaiyi Liang
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## Version
v1.0
## Frame Works
Python
Django
Boostrap
Qunit
...
## Supports
⋅⋅* Bulletpoint
⋅⋅⋅ Explanation
⋅⋅* Another Bulletpoint
⋅⋅⋅ Explanation
## References
(Demo)
[url link](https://github.com/danieldupriest/reimbursinator)
## License
[GNU Affero General Public License v3.0](https://opensource.org/licenses/AGPL-3.0)