diff --git a/README.md b/README.md index 71dc196..c7c7e2f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # Todocolors -A WIP self-hostable todo app in Rust and Next.js. +A self-hostable multiplayer todo app with Redis, Rust, WebSockets and Next.js. + +> Warning: +> +> This project is currently a prototype. +> +> Features may be changed, break, or have security issues without anything being communicated! +> +> The code is also rough and undocumented, and may get rewritten from scratch for the next iteration of the project! +> +> Terms are also written half in Italian and half in English for whatever reason. Whoops! +> +> Use and contribute at your own risk. + +## Screenshots + +![Screenshot of the application, detailing a nonsensical "Plan for conquering the world"](screenshot.png 'Screenshot of the application, detailing a nonsensical "Plan for conquering the world') \ No newline at end of file diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..aa9b011 Binary files /dev/null and b/screenshot.png differ