update README

sakihet · Oct 29, 2023 · ade2ebc · ade2ebc
1 parent 030a34b
commit ade2ebc
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # Trellith
 [![test](https://github.com/sakihet/trellith/actions/workflows/test.yaml/badge.svg)](https://github.com/sakihet/trellith/actions/workflows/test.yaml)
 
-[Trellith](https://trellith.sakih.net/) is an open source, tiny Trello clone PWA built with TypeScript and Preact. It's a personal tool that organizes your projects into boards. You can start using it by just opening the URL. There is no need to create any accounts. Data is only stored in your browser's localStorage. It's secure because the data isn't saved on the cloud.
+![board-light](screenshots/trellith-board-light.png)
 
-![trellith-logo](public/icon-192.png)
+[Trellith](https://trellith.sakih.net/) is an open source, tiny Trello clone PWA built with TypeScript and Preact. It's a personal tool that organizes your projects into boards. You can start using it by just opening the URL. There is no need to create any accounts. Data is only stored in your browser's localStorage. It's secure because the data isn't saved on the cloud.
 
 ## Motivation
 
@@ -52,6 +52,13 @@ Additional features:
 
 If you find any bugs or have feature requests, please create an issue and let me know.
 
+## Development
+
+```
+npm install
+npm run dev
+```
+
 ## License
 
 [MIT](./LICENSE)
diff --git a/screenshots/trellith-board-dark.png b/screenshots/trellith-board-dark.png
diff --git a/screenshots/trellith-board-light.png b/screenshots/trellith-board-light.png
diff --git a/screenshots/trellith-card-dark.png b/screenshots/trellith-card-dark.png
diff --git a/screenshots/trellith-card-light.png b/screenshots/trellith-card-light.png
diff --git a/screenshots/trellith-index-dark.png b/screenshots/trellith-index-dark.png
diff --git a/screenshots/trellith-index-light.png b/screenshots/trellith-index-light.png