Create README.md

README.md

@@ -0,0 +1,39 @@
+## Building
+Building this project requires installing the rust toolchain.
+
+To build the project (development):
+```
+cargo build
+```
+
+To run the project (development):
+```
+cargo run
+```
+This will start a server on port 3000.
+
+To build a release executable:
+```
+cargo build --release
+```
+The resulting executable will be loacted in `./target/release/`.
+
+## Testing
+Testing also requires the rust toolchain installed.
+
+To test the project:
+```
+cargo test
+```
+
+## Endpoints
+To interact with the cpu api, submit a `GET` request to `/api/cpus` with a `Content-Type` of `application/json`.
+
+The json submitted should look like this:
+```json
+{
+  "name": "CPU_TO_LOOK_UP"
+}
+```
+
+This endpoint does not guarantee the correctness of the model returned, it will always attempt to return a model.