{"id":23529720,"url":"https://github.com/jaid/tldw","last_synced_at":"2025-04-22T17:24:51.642Z","repository":{"id":46859094,"uuid":"168774639","full_name":"Jaid/tldw","owner":"Jaid","description":"Overwrites the readme based on info fetched from package.json and source code.","archived":false,"fork":false,"pushed_at":"2023-03-08T04:38:22.000Z","size":8968,"stargazers_count":2,"open_issues_count":9,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-01T14:49:32.176Z","etag":null,"topics":["documentation","github","jsx","markdown","react","react-renderer","readme","readme-template"],"latest_commit_sha":null,"homepage":"https://github.com/jaid/tldw","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/Jaid.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/funding.yml","license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Jaid","custom":"https://twitch.tv/products/jaidchen"}},"created_at":"2019-02-01T23:46:15.000Z","updated_at":"2023-03-10T09:05:28.000Z","dependencies_parsed_at":"2024-12-25T21:13:01.793Z","dependency_job_id":"07666a4f-49f5-4fb4-b60d-79129394e04b","html_url":"https://github.com/Jaid/tldw","commit_stats":{"total_commits":300,"total_committers":3,"mean_commits":100.0,"dds":"0.10999999999999999","last_synced_commit":"a3ee5efd070c72652384122819cbe5187ca710b3"},"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jaid%2Ftldw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jaid%2Ftldw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jaid%2Ftldw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jaid%2Ftldw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jaid","download_url":"https://codeload.github.com/Jaid/tldw/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250021151,"owners_count":21361976,"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":["documentation","github","jsx","markdown","react","react-renderer","readme","readme-template"],"created_at":"2024-12-25T21:12:48.857Z","updated_at":"2025-04-22T17:24:51.607Z","avatar_url":"https://github.com/Jaid.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Jaid","https://twitch.tv/products/jaidchen","https://github.com/sponsors/jaid"],"categories":[],"sub_categories":[],"readme":"# tldw\n\n\n\u003ca href=\"https://raw.githubusercontent.com/jaid/tldw/master/license.txt\"\u003e\u003cimg src=\"https://img.shields.io/github/license/jaid/tldw?style=flat-square\" alt=\"License\"/\u003e\u003c/a\u003e \u003ca href=\"https://github.com/sponsors/jaid\"\u003e\u003cimg src=\"https://img.shields.io/badge/\u003c3-Sponsor-FF45F1?style=flat-square\" alt=\"Sponsor tldw\"/\u003e\u003c/a\u003e  \n\u003ca href=\"https://actions-badge.atrox.dev/jaid/tldw/goto\"\u003e\u003cimg src=\"https://img.shields.io/endpoint.svg?style=flat-square\u0026url=https%3A%2F%2Factions-badge.atrox.dev%2Fjaid%2Ftldw%2Fbadge\" alt=\"Build status\"/\u003e\u003c/a\u003e \u003ca href=\"https://github.com/jaid/tldw/commits\"\u003e\u003cimg src=\"https://img.shields.io/github/commits-since/jaid/tldw/v7.3.1?style=flat-square\u0026logo=github\" alt=\"Commits since v7.3.1\"/\u003e\u003c/a\u003e \u003ca href=\"https://github.com/jaid/tldw/commits\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/jaid/tldw?style=flat-square\u0026logo=github\" alt=\"Last commit\"/\u003e\u003c/a\u003e \u003ca href=\"https://github.com/jaid/tldw/issues\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/jaid/tldw?style=flat-square\u0026logo=github\" alt=\"Issues\"/\u003e\u003c/a\u003e  \n\u003ca href=\"https://npmjs.com/package/tldw\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/tldw?style=flat-square\u0026logo=npm\u0026label=latest%20version\" alt=\"Latest version on npm\"/\u003e\u003c/a\u003e \u003ca href=\"https://github.com/jaid/tldw/network/dependents\"\u003e\u003cimg src=\"https://img.shields.io/librariesio/dependents/npm/tldw?style=flat-square\u0026logo=npm\" alt=\"Dependents\"/\u003e\u003c/a\u003e \u003ca href=\"https://npmjs.com/package/tldw\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/tldw?style=flat-square\u0026logo=npm\" alt=\"Downloads\"/\u003e\u003c/a\u003e\n\n**Overwrites the readme based on info fetched from package.json and source code.**\n\n#### Opinionated\n\n:warning: This project is tailored to my personal needs and workflows and therefore highly opinionated. Feel free to use it or get inspired by it, but please do not get frustrated if you come across weird features or difficulties integrating it in your own ecosystem.\n\n\n\n\n\n## Installation\n\n\u003ca href=\"https://npmjs.com/package/tldw\"\u003e\u003cimg src=\"https://img.shields.io/badge/npm-tldw-C23039?style=flat-square\u0026logo=npm\" alt=\"tldw on npm\"/\u003e\u003c/a\u003e\n\n```bash\nnpm install --global tldw@^7.3.1\n```\n\n\u003ca href=\"https://yarnpkg.com/package/tldw\"\u003e\u003cimg src=\"https://img.shields.io/badge/Yarn-tldw-2F8CB7?style=flat-square\u0026logo=yarn\u0026logoColor=white\" alt=\"tldw on Yarn\"/\u003e\u003c/a\u003e\n\n```bash\nyarn global add tldw@^7.3.1\n```\n\n\n\n\n\n\n## Usage\n\nGenerated readme can be extended with following files in your repository:\n\n##### Config\n\n- `readme/config.yml`\n\n##### YAML representation of Markdown fragments\n\n- `readme/envVars.yml` (same as `readme/config.yml#environmentVariables`)\n- `readme/usageOptions.yml`\n\n##### JavaScript fragments\n\n- `readme/example.js`\n- `readme/result*.js`\n\n##### Markdown fragments\n\n- `readme/legal.md`\n- `readme/warning.md`\n- `readme/usage.md`\n- `readme/advancedUsage.md`\n- `readme/example.md`\n- `readme/options.md`\n- `readme/development.md`\n- `readme/description.md`\n- `readme/result.md`\n- `readme/notes.md`\n- `readme/related.md`\n- `readme/faq.md`\n\n\n\n\n\n## CLI Usage\nAfter installing package `tldw` globally, you can use its command line interface.\n```bash\ntldw\n```\nFor usage instructions:\n```bash\ntldw --help\n```\n\n\n\n\n\n\n\n\n\n\n## Development\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eDevelopment hints for maintaining and improving tldw\u003c/b\u003e\u003c/summary\u003e\n\n\n\nSetting up:\n```bash\ngit clone git@github.com:jaid/tldw.git\ncd tldw\nnpm install\n```\nTesting:\n```bash\nnpm run test:dev\n```\nTesting in production environment:\n```bash\nnpm run test\n```\n\n\u003c/details\u003e\n\n## License\n[MIT License](https://raw.githubusercontent.com/jaid/tldw/master/license.txt)  \nCopyright © 2021, Jaid \\\u003cjaid.jsx@gmail.com\u003e (https://github.com/jaid)\n\n\u003c!---\nReadme generated with tldw v7.3.1\nhttps://github.com/Jaid/tldw\n--\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaid%2Ftldw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaid%2Ftldw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaid%2Ftldw/lists"}