{"id":16471870,"url":"https://github.com/abranhe/minutes-to-read","last_synced_at":"2025-10-26T01:18:15.516Z","repository":{"id":57298196,"uuid":"183319667","full_name":"abranhe/minutes-to-read","owner":"abranhe","description":"How long does it take you to read? ","archived":false,"fork":false,"pushed_at":"2019-04-26T04:23:47.000Z","size":12,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-04T03:11:24.521Z","etag":null,"topics":["medium","minutes","read","time","wpm"],"latest_commit_sha":null,"homepage":"https://p.abranhe.com/minutes-to-read","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/abranhe.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":"2019-04-24T23:15:46.000Z","updated_at":"2022-08-22T09:19:14.000Z","dependencies_parsed_at":"2022-09-06T03:30:31.181Z","dependency_job_id":null,"html_url":"https://github.com/abranhe/minutes-to-read","commit_stats":null,"previous_names":["abranhe/minutes-to-read","abrahamhba/minutes-to-read"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abranhe%2Fminutes-to-read","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abranhe%2Fminutes-to-read/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abranhe%2Fminutes-to-read/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abranhe%2Fminutes-to-read/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abranhe","download_url":"https://codeload.github.com/abranhe/minutes-to-read/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219861094,"owners_count":16556007,"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":["medium","minutes","read","time","wpm"],"created_at":"2024-10-11T12:15:03.790Z","updated_at":"2025-10-26T01:18:15.438Z","avatar_url":"https://github.com/abranhe.png","language":"JavaScript","funding_links":["https://patreon.com/abranhe","https://paypal.me/abranhe/10"],"categories":[],"sub_categories":[],"readme":"[\u003cimg src=\"https://cdn.abranhe.com/projects/minutes-to-read/logo.png\" height=\"80%\" width=\"80%\"\u003e](https://npmjs.org/minutes-to-read)\n\n\u003cbr/\u003e\n\n[![](https://api.abranhe.com/badges/travis/minutes-to-read)](https://travis-ci.org/abranhe/minutes-to-read)\n[![](https://img.shields.io/github/license/abranhe/minutes-to-read.svg)](https://github.com/abranhe/minutes-to-read/blob/master/license)\n[![](https://abranhe.com/badge.svg)](https://github.com/abranhe)\n[![](https://cdn.abranhe.com/badges/cash-me.svg)](https://cash.me/$abranhe)\n[![](https://cdn.abranhe.com/badges/patreon.svg)](https://patreon.com/abranhe)\n[![](https://cdn.abranhe.com/badges/paypal.svg)](https://paypal.me/abranhe/10)\n[![](https://img.shields.io/npm/v/minutes-to-read.svg)](https://npmjs.org/minutes-to-read)\n\nRead time is based on the average reading speed of an adult (roughly 265 [Words per minutes](https://en.wikipedia.org/wiki/Words_per_minute) according to a [Medium's article](https://help.medium.com/hc/en-us/articles/214991667-Read-time).\n\n## Install\n\n```\n$ npm install minutes-to-read\n```\n\n## Usage\n\n```js\nconst m2r = require('minutes-to-read');\n\nm2r('Lorem ipsum');\n// =\u003e less than a min to read\n\nm2r('Lorem ipsum', 'minute');\n// =\u003e less than a minute\n\nconst longText = 'Lorem ipsum dolor sit am...' // 500 words \n\nm2r(longText, 'minutes to finish');\n// =\u003e 2 minutes to finish\n\nm2r(longText, 'minutes to read if your reading rate is 2 wpm', 2);\n// =\u003e 250 minutes to read if your reading rate is 2 wpm\n```\n\n## API\n\n### `m2r(text)`\n\n- **text** (`string`): A paragraph, easy or sentence \n\n###### Example:\n\n```js\nm2r('Lorem ipsum');\n// =\u003e less than a minute\n\n\nm2r('Lorem ipsum dolor sit am...'); // 500 words \n// =\u003e 2 minutes to finish\n```\n\n### `m2r(text, customText)`\n\n- **text** (`string`): A paragraph, easy or sentence \n- **customText** (`string`): A custom text you want to add\n\n###### Example:\n\n```js\nm2r('Lorem ipsum', 'minute to finish');\n// =\u003e less than a minute to finish\n```\n\n### `m2r(text, customText, wpm)`\n\n- **text** (`string`): A paragraph, easy or sentence \n- **customText** (`string`): A custom text you want to add\n- **wpm** (`number`): Custom words per minutes\n\n###### Example:\n\nFor a 250 text at 2 words per minutes it will take 250 minutes.\n\n```js\nm2r('Lorem ipsum dolor sit am...', 'minutes to finish', 2); // 500 words \n// =\u003e 250 minutes to finish\n```\n\n### `m2r(text,wpm)`\n\n- **text** (`string`): A paragraph, easy or sentence \n- **wpm** (`number`): Custom words per minutes\n\n###### Example:\n\nFor a 2 words text reading a word per minute it will take 2 minutes.\n\n```js\nm2r('Lorem ipsum', 1);\n// =\u003e 2 min to read\n```\n\n## Team\n\n|[![](https://api.abranhe.com/avatar?s=50)](https://abranhe.com)|\n| :-: |\n| [Carlos Araham](https://github.com/abranhe) |\n\n\n## License\n\n[MIT](https://github.com/abranhe/minutes-to-read/blob/master/license) License © [Carlos Abraham](https://github.com/abranhe)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabranhe%2Fminutes-to-read","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabranhe%2Fminutes-to-read","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabranhe%2Fminutes-to-read/lists"}