Skip to content

Commit

Permalink
Merge pull request #5 from rugglcon/add-readme
Browse files Browse the repository at this point in the history
add readme and simple description
  • Loading branch information
rugglcon authored Oct 4, 2019
2 parents 0446bd3 + 95a019b commit 9533a8f
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Budgets API

This is a fully self-contained NodeJS API, easily deployable to a server for use.

## Installation

Deploy as you wish, the endpoints are exposed however you want them to be.

## Usage

```
GET /budgets/1
{ id: 1, name: "Budget", total: 50, ownerId: 1 }
```

## Contributing
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.

## License
[MIT](https://choosealicense.com/licenses/mit/)

0 comments on commit 9533a8f

Please sign in to comment.