https://github.com/avr/obsidian-reading-time

https://github.com/avr/obsidian-reading-time

obsidian-md obsidian-plugin

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/avr/obsidian-reading-time
• Owner: avr
• License: mit
• Created: 2020-10-27T03:50:29.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-10T19:48:39.000Z (2 months ago)
• Last Synced: 2024-09-10T22:45:09.153Z (2 months ago)
• Topics: obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 396 KB
• Stars: 64
• Watchers: 4
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - avr/obsidian-reading-time - (TypeScript)

README

        
# Obsidian Reading Time Plugin

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

![Screenshot](https://raw.githubusercontent.com/avr/obsidian-reading-time/main/images/example.png)

![Screenshot](https://raw.githubusercontent.com/avr/obsidian-reading-time/main/images/settings.png)

## How to install the plugin

- Download the [Latest release](https://github.com/avr/obsidian-reading-time/releases/latest)

- Extract the `obsidian-reading-time` folder from the zip to your 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.