diff --git a/CHANGELOG.md b/CHANGELOG.md index d610f87..7221196 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ This file keeps track of changes in more human-readable fashion * Known issue: making notes is impossible in the PWA, since you can't navigate to arbitrary page. I might leave it as a WONTFIX or try to find a workaround * Date is now shown in local language if possible (in case you add your own or use Russian) +* Added API reference to README * Bug fixes * "Today" redirect from days list no longer uses UTC * Date JS script no longer uses UTC diff --git a/README.md b/README.md index 4fb37d7..3afbbc2 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,18 @@ As a result, I can't guarantee that it's either secure or stable. ## Features: * Each day, you get a new text file. You have until the end of that very day to finalise it. * You can save named notes to document milestones, big events, or just a nice game you played this month -* You can easily export entire `data` dir in a `.zip` archive for backups +* You can easily export the files in a `.zip` archive for backups * Everything is plain(text) and simple. No databases, encryption, OAuth, or anything fancy. Even the password is plainte- *wait is this a feature?* * Docker support (in fact, that's probably the best way to run this) * Optional Telegram notifications for failed login attempts ## Technical details +Though Hibiscus.txt isn't versioned, [CHANGELOG.md](./CHANGELOG.md) can provide a good overview of changes. +And there is a [TODO.md](./TODO.md) file that shows what I will (or *may*) work on in the future. + You can read a relevant entry in my blog [here](https://a71.su/notes/hibiscus/). It provides some useful information and context for why this app exists in the first place. -There is also a [TODO.md](./TODO.md) file that shows what I will (or *may*) change in the future. This repository is [mirrored to GitHub](https://github.com/Andrew-71/hibiscus) in case my server goes down. ### Data format: diff --git a/TODO.md b/TODO.md index d134465..0612c5d 100644 --- a/TODO.md +++ b/TODO.md @@ -1,8 +1,8 @@ # TODO List of things to add to this project +* a 512x logo so I can enable PWA * CI/CD pipeline * Better docs in case others want to use this for some reason -* PWA support? I heard it's like installing websites as apps, could be useful! * Check export function for improvements * *Go* dependency-less? <-- this is a terrible idea \ No newline at end of file