1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fa24ecf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Model Viewer Demo
+
+A demo of how to use react and three.js to view and manipulate models.
+
+## Running and Building
+
+This project uses a `Makefile` for all tasks.
+
+- `make dev` runs the local development server.
+- `make build` creates builds the js bundle.
+
+## Linting and Formatting
+
+This project uses `prettier` and `eslint`.
+
+- `make format` formats the code (and runs lints) 
+- `make lint` lints the  code
+
+## Running Tests
+
+- `make test` Runs the tests
+
+## Container
+
+This project includes a Containerfile that you can use to quickly run the
+project.
+
+## License
+
+Licensed under AGPL 3.0