Updating README, adding presentation slides, and MIT License

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Daniel Bank
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,7 +1,21 @@
-# offline-ml
+# Offline ML with Rust
 
-Offline ML with Rust
+A simple REST API server built using the [gotham](https://gotham.rs/) web framework, [tract](https://github.com/snipsco/tract) for neural network inference, and [Rust](https://www.rust-lang.org/).
+
+## Slide Deck
+
+This project was created as a demo for an accompanying talk: **Offline ML with Rust**. The [slide deck](docs/offline-ml.pdf) is included in this repo in the `/docs` folder.
+
+## Usage
+
+Start the server by running `cargo run`
+
+The API server listens for POST requests to the root endpoint with a body containing a serializable image (I've only tested with JPEGs). You can use cURL to upload images:
 
 ```
-curl -i  -X POST -F "image=@/Users/DanielBank/Desktop/grace_hopper.jpg" http://127.0.0.1:7878/
+curl -i  -X POST -F "image=@<IMAGE_PATH>" http://127.0.0.1:7878/
 ```
+
+## License
+
+[MIT License](LICENSE)