diff --git a/README.md b/README.md index 20586083c584bd8fd992ab91284c910cc7088a88..4ef05554d8085b5c599572b527ae47cf21a521dd 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,14 @@ -This is a [Kobweb](https://github.com/varabyte/kobweb) project instantiated from the `examples/todo` template. - -The purpose of this project is to showcase a minimal Todo app, demonstrating: - -* a simple, reactive, single-page web app, making use of both Silk UI and Compose for Web -* API endpoints (e.g. for adding, removing, and fetching items) -* how to share types across client and server (see `TodoItem` which has text and an ID value) - -I'd like to give credit to https://blog.upstash.com/nextjs-todo for sharing the Next.js version. - +This is a to-do list web application developed with usage of Kotlin framework Kobweb and MongoDB. +User can view all their tasks, both unfinished and finished. User can click on an unfinished task +to move it to finished section. All tasks can be deleted from db completely. +Also, user has ability to change theme to dark and back to light. --- -To run the sample, simply enter the following commands in the terminal: +To run the application, simply enter the following commands in the terminal: ```bash $ cd site $ kobweb run ``` -and open [http://localhost:8080](http://localhost:8080) with your browser to see the result. +and open http://localhost:8080 with your browser to see the result.