{"id":19972590,"url":"https://github.com/jpb06/readme-package-icons","last_synced_at":"2025-05-04T01:30:51.702Z","repository":{"id":43787965,"uuid":"511641186","full_name":"jpb06/readme-package-icons","owner":"jpb06","description":"Displaying dependencies as icons in repositories readme","archived":false,"fork":false,"pushed_at":"2025-04-26T19:34:51.000Z","size":1404,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-26T20:26:13.662Z","etag":null,"topics":["readme"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jpb06.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-07-07T18:52:40.000Z","updated_at":"2025-04-26T19:34:21.000Z","dependencies_parsed_at":"2025-02-26T00:23:59.115Z","dependency_job_id":"579deab2-8d1e-4cc1-a5ce-343586b88692","html_url":"https://github.com/jpb06/readme-package-icons","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Freadme-package-icons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Freadme-package-icons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Freadme-package-icons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpb06%2Freadme-package-icons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jpb06","download_url":"https://codeload.github.com/jpb06/readme-package-icons/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252276955,"owners_count":21722447,"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":["readme"],"created_at":"2024-11-13T03:08:37.885Z","updated_at":"2025-05-04T01:30:51.692Z","avatar_url":"https://github.com/jpb06.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# readme-package-icons\n\n[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode\u0026label=\u0026message=Open%20in%20Visual%20Studio%20Code\u0026labelColor=2c2c32\u0026color=007acc\u0026logoColor=007acc)](https://github.dev/jpb06/readme-package-icons)\n![npm bundle size](https://img.shields.io/bundlephobia/min/readme-package-icons)\n![Github workflow](https://img.shields.io/github/actions/workflow/status/jpb06/readme-package-icons/ci.yml?branch=main\u0026logo=github-actions\u0026label=last%20workflow)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=jpb06_readme-package-icons)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=jpb06_readme-package-icons)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=security_rating)](https://sonarcloud.io/dashboard?id=jpb06_readme-package-icons)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=reliability_rating)](https://sonarcloud.io/dashboard?id=jpb06_readme-package-icons)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=jpb06_readme-package-icons)\n[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=ncloc)](https://sonarcloud.io/summary/new_code?id=jpb06_readme-package-icons)\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=jpb06_readme-package-icons)\n[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=code_smells)](https://sonarcloud.io/dashboard?id=jpb06_readme-package-icons)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=bugs)](https://sonarcloud.io/summary/new_code?id=jpb06_readme-package-icons)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=jpb06_readme-package-icons)\n[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=jpb06_readme-package-icons\u0026metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=jpb06_readme-package-icons)\n![Last commit](https://img.shields.io/github/last-commit/jpb06/readme-package-icons?logo=git)\n\nGenerating a list of icons from dependencies.\n\n\u003c!-- readme-package-icons start --\u003e\n\n\u003cp align=\"left\"\u003e\u003ca href=\"https://docs.github.com/en/actions\" target=\"_blank\"\u003e\u003cimg height=\"70\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/GithubActions-Dark.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://www.typescriptlang.org/docs/\" target=\"_blank\"\u003e\u003cimg height=\"70\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/TypeScript.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://nodejs.org/en/docs/\" target=\"_blank\"\u003e\u003cimg height=\"70\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/NodeJS-Dark.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://bun.sh/docs\" target=\"_blank\"\u003e\u003cimg height=\"70\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Bun-Dark.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://biomejs.dev/guides/getting-started/\" target=\"_blank\"\u003e\u003cimg height=\"70\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Biome-Dark.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://github.com/conventional-changelog\" target=\"_blank\"\u003e\u003cimg height=\"70\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/CommitLint.Dark.svg\" /\u003e\u003c/a\u003e\u0026nbsp;\u003ca href=\"https://vitest.dev/guide/\" target=\"_blank\"\u003e\u003cimg height=\"70\" src=\"https://raw.githubusercontent.com/jpb06/jpb06/master/icons/Vitest-Dark.svg\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003c!-- readme-package-icons end --\u003e\n\nBlabla\n```\n\nOur icons list will be inserted between these two tags.\n\n#### 🌀 Cli\n\nOne way to use this package is to use its executable. The `generateReadmeIcons` function takes two optional arguments:\n\n| name | description          | Example  | Default |\n| ---- | -------------------- | -------- | ------- |\n| p    | The path to the repo | ./myRepo | .       |\n| h    | Height of the icons  | 100      | 50      |\n\n##### 🍥 Within a package\n\nWe could add a script to our package.json for example:\n\n```json\n{\n  \"scripts\": {\n    \"readme-icons\": \"generateReadmeIcons\"\n  }\n}\n```\n\n##### 🍥 Globally\n\nWe can also install the package globally:\n\n```bash\nnpm install -g readme-package-icons\n```\n\nThen we can use it by using the `-p` option:\n\n```bash\nnpm run generateReadmeIcons -p /Users/jpb06/repos/myRepo\n```\n\nYou can also use the esm version:\n\n```bash\nnpm run generateReadmeIconsEsm -p /Users/jpb06/repos/myRepo\n```\n\n#### 🌀 node\n\nThis package exposes the function as well:\n\n```typescript\nimport { generateReadmeIcons } from 'readme-package-icons';\n\n(async (): Promise\u003cvoid\u003e =\u003e {\n  const path = './path/to/my/repo';\n  const iconsHeight = 50;\n\n  const iconsAddedToReadmeCount = await generateReadmeIcons({\n    path,\n    iconsHeight,\n  });\n})();\n```\n\n## ⚡ Thanks\n\nThis module uses some icons from [devicons](https://github.com/devicons/devicon/). Thanks for their great work!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpb06%2Freadme-package-icons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpb06%2Freadme-package-icons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpb06%2Freadme-package-icons/lists"}