add readme and simple description

rugglcon · Oct 4, 2019 · 95a019b · 95a019b
1 parent 0446bd3
commit 95a019b
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -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/)