Skip to content

Commit 093903c

Browse files
committed
Enhance README with additional links to documentation and GitHub, and update useful commands section to include documentation build commands.
1 parent 1d6fa43 commit 093903c

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ A local-first diary: **one note per day**, organized by **diary** and **date**.
66
- **Multiple diaries**: switch diaries from the navbar
77
- **Calendar day view**: `/calendar/YYYY-MM-DD` shows the entry for that day
88

9+
**Links:** [Documentation](https://amide-init.github.io/mindlog/) · [GitHub](https://github.com/amide-init/mindlog)
10+
911
## Requirements
1012

1113
- **Node.js**: >= 22.5
@@ -45,8 +47,10 @@ Open `http://localhost:3000`.
4547
## Useful commands
4648

4749
```bash
48-
pnpm db:migrate # run prisma migrations (dev)
49-
pnpm db:studio # open Prisma Studio
50+
pnpm db:migrate # run prisma migrations (dev)
51+
pnpm db:studio # open Prisma Studio
52+
pnpm docs:dev # run docs site locally (http://localhost:5173)
53+
pnpm docs:build # build docs for deployment
5054
pnpm lint
5155
pnpm build
5256
pnpm start
@@ -59,4 +63,4 @@ pnpm start
5963

6064
## License
6165

62-
MIT — see `LICENSE`.
66+
MIT — see [LICENSE](https://github.com/amide-init/mindlog/blob/main/LICENSE).

0 commit comments

Comments
 (0)