{"id":19901334,"url":"https://github.com/lissy93/readme-contribs","last_synced_at":"2025-08-15T14:19:40.376Z","repository":{"id":245942625,"uuid":"819627683","full_name":"Lissy93/readme-contribs","owner":"Lissy93","description":"💞  Simple embeddable contributor and sponsor widgets for your GitHub README ","archived":false,"fork":false,"pushed_at":"2024-06-28T13:39:58.000Z","size":248,"stargazers_count":16,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T08:31:44.172Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://readme-contribs.as93.net","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Lissy93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-06-24T22:32:04.000Z","updated_at":"2025-03-29T16:25:57.000Z","dependencies_parsed_at":"2024-06-24T23:47:49.164Z","dependency_job_id":"81ebb87f-85e0-4221-85c3-ed0131d1ae6f","html_url":"https://github.com/Lissy93/readme-contribs","commit_stats":null,"previous_names":["lissy93/readme-contribs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Freadme-contribs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Freadme-contribs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Freadme-contribs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lissy93%2Freadme-contribs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Lissy93","download_url":"https://codeload.github.com/Lissy93/readme-contribs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252122273,"owners_count":21698305,"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":[],"created_at":"2024-11-12T20:14:40.904Z","updated_at":"2025-05-02T23:31:40.615Z","avatar_url":"https://github.com/Lissy93.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eReadme Contribs\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\u003ci\u003eSimple embeddable contributor and sponsor widgets for your GitHub README\u003c/i\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://readme-contribs.as93.net/\"\u003e\n    🌐 \u003cb\u003ereadme-contribs.as93.net\u003c/b\u003e\u003cbr\u003e\u003cbr\u003e\n    \u003cimg width=\"100\" src=\"https://github.com/Lissy93/readme-contribs/blob/main/public/favicon.png?raw=true\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003eContents\u003c/summary\u003e\n\n- [About](#about)\n   * [Motivation](#motivation)\n- [Usage](#usage)\n   * [Embedding](#embedding)\n   * [Base Domain](#base-domain)\n   * [Embed Contributors](#embed-contributors)\n   * [Embed Sponsors](#embed-sponsors)\n   * [Embed Stargazers](#embed-stargazers)\n   * [Embed Forkers](#embed-forkers)\n   * [Image Options](#image-options)\n- [Deploying your Own](#deploying-your-own)\n- [Developing](#developing)\n- [Examples](#examples)\n- [Web Interface](#web-interface)\n- [Attributions](#attributions)\n   * [Contributors](#contributors)\n   * [Sponsors](#sponsors)\n- [License](#license)\n\n\u003c/details\u003e\n\n---\n\n## About\n\n### Motivation\n\nIt's nice to give credit to contributors and supporters who've helped your project 💞\n\nBut using GitHub Actions to generate these causes your commit history to become unnecessarily cluttered. And existing services to embed contributor widgets aren't very customizable and don't support sponsors or stargazers.\n\nMy aim with this project, is to provide an easy way for you to embed your projects contributors, sponsors, stargazers, etc, and to let you configure the look and feel. You can also easily deploy this project to Vercel, so you'll never need to worry about the managed instance becoming unavailable. [↳ See Examples](#examples)\n\n---\n\n## Usage\n\n### Embedding\nTo embed the image in your markdown, simply use the endpoint as the image URL.\u003cbr /\u003e\nFor example:\n\n```\n![Sponsors](https://readme-contribs.as93.net/sponsors/lissy93)\n```\n\n### Base Domain\nThe following API routes are to be made from the base domain.\u003cbr /\u003e\nFor the public instance, use `https://readme-contribs.as93.net`.\u003cbr /\u003e\nIf you're hosting your own instance, update this to your domain.\u003cbr /\u003e\n\n### Embed Contributors\n\n```\n/contributors/[user]/[repo]\n```\n\n\n### Embed Sponsors\n\n```\n/sponsors/[user]\n```\n\n\n### Embed Stargazers\n\n```\n/stargazers/[user]/[repo]\n```\n\n\n### Embed Forkers\n\n```\n/sponsors/[user]/[repo]\n```\n\n### Image Options\n\nYou can customize the outputed image, it's appearence and functionality with the following options. \u003cbr /\u003e\nSpecify these as query string parameters, appended to the end of your GET request. All values are optional.\n\n| Parameter          | Description                                      | Type    | Default Value                       |\n|--------------------|--------------------------------------------------|---------|-------------------------------------|\n| `title`            | The title to be displayed above the widget       | String  | `''` (Empty string = no title)      |\n| `avatarSize`       | Minimum size of avatars                          | Integer | `50`                                |\n| `perRow`           | Maximum number of avatars per row                | Integer | `8`                                 |\n| `shape`            | Shape of the avatar images (square, circle, squircle) | Enum    | `square`                       |\n| `hideLabel`        | If set to true, name labels will not be displayed | Boolean | `false`                            |\n| `fontSize`         | Font size for label text                         | Integer | `12`                                |\n| `fontFamily`       | Font family for the text                         | String  | `'Mona Sans', Verdana, sans-serif`  |\n| `textColor`        | Color of the text (as hex code excluding # or color name)  | String  | `333333` (exclude the `#`) |\n| `backgroundColor`  | Background color of the widget                   | String  | `transparent`                       |\n| `limit`            | Maximum number of items to display               | Integer | `100`                               |\n| `outerBorderWidth` | Width of the outer border                        | Integer | `0`                                 |\n| `outerBorderColor` | Color of the outer border                        | String  | `''` (Empty string = no border)     |\n| `outerBorderRadius`| Radius of the outer border corners               | Integer | `0`                                 |\n| `margin`           | Margin around each avatar                        | Integer | `20`                                |\n| `textOffset`       | Offset for text alignment below avatars          | Integer | `20`                                |\n| `svgWidth`         | Width of the entire SVG widget                   | Integer | `500`                               |\n| `svgHeight`        | Height of the entire SVG widget                  | Integer | `500`                               |\n| `dynamic`          | If true, won't base64 encode images, faster (iframe usage only) | Boolean | `false`              |\n| `isResponsive`     | If true, makes the widget responsive             | Boolean | `false`                             |\n\nView the [Swagger Docs](https://readme-contribs.as93.net/api-docs) for more details.\n\n---\n\n## Deploying your Own\n\nIf you plan to use this at any kind of scale, it is highly reccomended to deploy your own instance.\n\nDon't worry, it's super quick, easy and free!\n\n1. Fork this repository (by clicking [here](https://github.com/Lissy93/readme-contribs/fork))\n2. Login / Sign up to [Vercel](https://vercel.com/login)\n3. Create a new app, and select your newly forked repo\n4. Create a GitHub API token [here](https://github.com/settings/tokens?type=beta)\n5. Add the `GITHUB_TOKEN` environmental variable into Vercel\n6. Hit deploy!\n\n---\n\n## Developing\n\nYou can run readme-contribs locally, to make and preview any changes\n\n1. Get the code: `git clone git@github.com:Lissy93/readme-contribs.git`\n2. Navigate into the directory: `cd readme-contribs`\n3. Install dependencies: `yarn` (or `npn install`)\n4. Start the development server: `yarn start`\n5. Then open the running app at `localhost:3000`\n\nDon't forget to add your token in the `GITHUB_TOKEN` environmental variable (or put it in `.env`)\n\n---\n\n## Examples\n\n\u003cdetails\u003e\u003csummary\u003eExample 1\u003c/summary\u003e\n\n![Rust Lang Contributors](https://readme-contribs.as93.net/contributors/rust-lang/rust?hideLabel=true\u0026margin=2\u0026textOffset=0\u0026perRow=10\u0026title=Rust%20Lang%20Top%20Contributors\u0026footerText=none)\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eExample 2\u003c/summary\u003e\n\n![Dashy Contributors](https://readme-contribs.as93.net/contributors/lissy93/dashy?shape=squircle\u0026perRow=10\u0026title=Lissy93%2FDashy%27s%20Top%20Contributors\u0026textColor=black\u0026backgroundColor=00d1b2\u0026margin=6\u0026hideLabel=true\u0026textOffset=2\u0026footerText=none)\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eExample 3\u003c/summary\u003e\n\n![AdGuardian Forkers](http://readme-contribs.as93.net/forkers/Lissy93/AdGuardian-Term?title=AdGuardian%20Forkers\u0026textColor=bfbfbf\u0026outerBorderWidth=2\u0026outerBorderRadius=5\u0026footerText=none)\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eExample 4\u003c/summary\u003e\n\n![Lissy93 Sponsors](https://readme-contribs.as93.net/sponsors/lissy93?shape=squircle\u0026margin=16\u0026textOffset=8\u0026perRow=6\u0026title=@Lissy93%27s%20Sponsors\u0026textColor=white\u0026\u0026backgroundColor=black\u0026fontFamily=Courier%20New\u0026fontSize=8\u0026footerText=none)\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eExample 5\u003c/summary\u003e\n\n![Web Check Stargazers](https://readme-contribs.as93.net/stargazers/lissy93/web-check?shape=square\u0026margin=16\u0026perRow=15\u0026title=Web-Checks%20Stargazers\u0026textColor=9fef00\u0026backgroundColor=101215\u0026fontFamily=cursive\u0026fontSize=14\u0026limit=90\u0026footerText=none)\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eExample 6\u003c/summary\u003e\n\n![Hot Dog Stand lolz](https://readme-contribs.as93.net/stargazers/steverichey/hot-dog-stand?backgroundColor=red\u0026textColor=yellow\u0026outerBorderWidth=5\u0026outerBorderRadius=8fontFamily=Comic%20Sans\u0026fontSize=12\u0026avatarSize=64\u0026perRow=4\u0026title=SteveRichey/Hot-Dog-Stand\u0026footerText=none\u0026shape=circle)\n\u003c/details\u003e\n\n---\n\n## Web Interface\nIf you're finding constructing the URL, and previewing the different options tricky, you can use our web interface to build your embedable card.\n\nVisit [readme-contribs.as93.net](https://readme-contribs.as93.net/) to get started.\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://readme-contribs.as93.net\"\u003e\u003cimg width=\"800\" src=\"https://github.com/Lissy93/readme-contribs/assets/1862727/01dc1664-e78e-449b-bb9d-76a92c4487b6\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\n---\n\n## Attributions\n\n### Contributors\n\n![Contributors](https://readme-contribs.as93.net/contributors/lissy93/readme-contribs)\n\n### Sponsors\n\n![Sponsors](https://readme-contribs.as93.net/sponsors/lissy93)\n\n---\n\n## License\n\n\u003e _**[Lissy93/README-Contribs](https://github.com/Lissy93/readme-contribs)** is licensed under [MIT](https://github.com/Lissy93/readme-contribs/blob/HEAD/LICENSE) © [Alicia Sykes](https://aliciasykes.com) 2024._\u003cbr\u003e\n\u003e \u003csup align=\"right\"\u003eFor information, see \u003ca href=\"https://tldrlegal.com/license/mit-license\"\u003eTLDR Legal \u003e MIT\u003c/a\u003e\u003c/sup\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eExpand License\u003c/summary\u003e\n\n```\nThe MIT License (MIT)\nCopyright (c) Alicia Sykes \u003calicia@omg.com\u003e \n\nPermission is hereby granted, free of charge, to any person obtaining a copy \nof this software and associated documentation files (the \"Software\"), to deal \nin the Software without restriction, including without limitation the rights \nto use, copy, modify, merge, publish, distribute, sub-license, and/or sell \ncopies of the Software, and to permit persons to whom the Software is furnished \nto do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included install \ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,\nINCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A\nPARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n```\n\n\u003c/details\u003e\n\n\u003c!-- License + Copyright --\u003e\n\u003cp  align=\"center\"\u003e\n  \u003ci\u003e© \u003ca href=\"https://aliciasykes.com\"\u003eAlicia Sykes\u003c/a\u003e 2024\u003c/i\u003e\u003cbr\u003e\n  \u003ci\u003eLicensed under \u003ca href=\"https://gist.github.com/Lissy93/143d2ee01ccc5c052a17\"\u003eMIT\u003c/a\u003e\u003c/i\u003e\u003cbr\u003e\n  \u003ca href=\"https://github.com/lissy93\"\u003e\u003cimg src=\"https://i.ibb.co/4KtpYxb/octocat-clean-mini.png\" /\u003e\u003c/a\u003e\u003cbr\u003e\n  \u003csup\u003eThanks for visiting :)\u003c/sup\u003e\n\u003c/p\u003e\n\n\u003c!-- Dinosaur --\u003e\n\u003c!-- \n                        . - ~ ~ ~ - .\n      ..     _      .-~               ~-.\n     //|     \\ `..~                      `.\n    || |      }  }              /       \\  \\\n(\\   \\\\ \\~^..'                 |         }  \\\n \\`.-~  o      /       }       |        /    \\\n (__          |       /        |       /      `.\n  `- - ~ ~ -._|      /_ - ~ ~ ^|      /- _      `.\n              |     /          |     /     ~-.     ~- _\n              |_____|          |_____|         ~ - . _ _~_-_\n--\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flissy93%2Freadme-contribs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flissy93%2Freadme-contribs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flissy93%2Freadme-contribs/lists"}