No description
Find a file
2024-09-10 15:48:36 -04:00
.github/workflows 🤖 ci: #15 Add build to lint check 2024-08-30 20:01:33 -04:00
images Update settings image 2021-12-29 11:14:57 -05:00
src 🔨 refactor: use enum for read time formats 2024-09-10 15:48:36 -04:00
.gitignore - Update folder structure 2021-12-28 22:51:03 -05:00
CHANGELOG.md 📚 docs: Correct changelog links 2024-08-30 21:34:50 -04:00
esbuild.config.mjs 🔨 refactor: #15 Update esbuild config for new version 2024-08-30 20:13:35 -04:00
eslint.config.mjs 🤖 ci: #15 Upgrade typescript, eslint, and other dependencies 2024-08-30 19:50:14 -04:00
LICENSE Add LICENSE 2024-09-09 00:05:36 -04:00
manifest.json feat: Release v1.1.2 2024-08-30 21:28:27 -04:00
package.json feat: Release v1.1.2 2024-08-30 21:28:27 -04:00
README.md feat: Release v1.1.2 2024-08-30 21:28:27 -04:00
tsconfig.json 🤖 ci: #15 Upgrade typescript, eslint, and other dependencies 2024-08-30 19:50:14 -04:00
version-bump.mjs feat: Release v1.1.2 2024-08-30 21:28:27 -04:00
versions.json feat: Release v1.1.2 2024-08-30 21:28:27 -04:00

Obsidian Reading Time Plugin

Simple plugin to add an estimated reading time for the selected note to the StatusBar.

Screenshot Screenshot

How to install the plugin

  • Download the Latest release
  • Extract the obsidian-reading-time folder from the zip to your vault <vault>/.obsidian/plugins/

Contributing

Development

npm install
npm run build
cp main.js manifest.json /path/to/your/vault/.obsidian/plugins/obsidian-reading-time

Release

  • After all changes for the release are merged create a new branch for the release
  • Update the changelog with new features and fixes
  • Run the version-bump.mjs script with the new version as an argument
  • Commit all changed files and create a pull request
  • After the pull request is merged, create a new annotated tag for the release:
git checkout main
git pull
git tag -a x.y.z -m "x.y.z"
git push --tags

The release will automatically be drafted.