{"id":15416731,"url":"https://github.com/bunlong/react-reading-time-estimator","last_synced_at":"2025-04-19T14:33:40.249Z","repository":{"id":45882596,"uuid":"337149999","full_name":"Bunlong/react-reading-time-estimator","owner":"Bunlong","description":"Medium's like reading time estimator for React.","archived":false,"fork":false,"pushed_at":"2021-11-30T03:28:53.000Z","size":46,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-22T17:07:45.125Z","etag":null,"topics":["hook","hooks","react","react-reading-time-estimator","reactjs","reading-time"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Bunlong.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-08T17:11:30.000Z","updated_at":"2023-03-23T06:39:36.000Z","dependencies_parsed_at":"2022-09-10T17:01:36.427Z","dependency_job_id":null,"html_url":"https://github.com/Bunlong/react-reading-time-estimator","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bunlong%2Freact-reading-time-estimator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bunlong%2Freact-reading-time-estimator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bunlong%2Freact-reading-time-estimator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bunlong%2Freact-reading-time-estimator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bunlong","download_url":"https://codeload.github.com/Bunlong/react-reading-time-estimator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232548628,"owners_count":18540149,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hook","hooks","react","react-reading-time-estimator","reactjs","reading-time"],"created_at":"2024-10-01T17:13:38.261Z","updated_at":"2025-01-05T05:02:00.466Z","avatar_url":"https://github.com/Bunlong.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-reading-time-estimator\n\nMedium's like reading time estimator for React.\n\n`react-reading-time-estimator` helps you estimate how long an article will take to read. It works perfectly with plain text.\n\n## 🎁 Features\n\n* Compatible with both JavaScript and TypeScript\n\n## 🔧 Install\n\nreact-reading-time-estimator is available on npm. It can be installed with the following command:\n\n```\nnpm install react-reading-time-estimator --save\n```\n\nreact-reading-time-estimator is available on yarn as well. It can be installed with the following command:\n\n```\nyarn add react-reading-time-estimator\n```\n\n## 💡 Usage\n\n```js\nimport { useReadingTime } from \"react-reading-time-estimator\";\n\nconst {\n  text, // 1 min read\n  minutes, // 1\n  words, // 168\n  time, // 0.5309090909090909\n} = useReadingTime(text);\n```\n\n## 📚 Hook\n\n`useReadingTime(text: string)`\n  * `text` – the text to be estimated.\n\n## 💖 Wrap Up\n\nIf you think any of the `react-reading-time-estimator` can be improved, please do open a PR with any updates and submit any issues. Also, I will continue to improve this, so you might want to watch/star this repository to revisit.\n\n## 🌟 Contribution\n\nWe'd love to have your helping hand on contributions to `react-reading-time-estimator` by forking and sending a pull request!\n\nYour contributions are heartily ♡ welcome, recognized and appreciated. (✿◠‿◠)\n\nHow to contribute:\n\n- Open pull request with improvements\n- Discuss ideas in issues\n- Spread the word\n- Reach out with any feedback\n\n## ⚖️ License\n\nThe MIT License [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n\u003c!-- https://raw.githubusercontent.com/bunlong/react-barcodes/master/README/logo.png --\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbunlong%2Freact-reading-time-estimator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbunlong%2Freact-reading-time-estimator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbunlong%2Freact-reading-time-estimator/lists"}