{"id":16102764,"url":"https://github.com/proffapt/myreadme","last_synced_at":"2025-08-30T14:31:17.516Z","repository":{"id":134108667,"uuid":"474727355","full_name":"proffapt/myREADME","owner":"proffapt","description":"Contains my templates for README.md, LICENSE.txt CONTRIBUTING.md COC.md, issues \u0026 pull_request. With a workflow to generate/update CHANGELOG.md and draft release on tag push.","archived":false,"fork":false,"pushed_at":"2024-04-19T12:26:57.000Z","size":356,"stargazers_count":10,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T08:48:18.873Z","etag":null,"topics":["about-project","changelog","codeofconduct","contributing","github-about","github-actions","github-docs","github-docs-template","github-readme-example","github-readme-generator","github-readme-template","github-release-action","github-release-automation","github-release-workflow","github-releases","license","readme","readme-template","readymade-readme","security"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/proffapt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-03-27T18:40:58.000Z","updated_at":"2025-02-06T13:42:26.000Z","dependencies_parsed_at":"2024-04-19T13:42:57.282Z","dependency_job_id":"dede2e25-ce1c-4db7-97bc-82f38db46e22","html_url":"https://github.com/proffapt/myREADME","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/proffapt/myREADME","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/proffapt%2FmyREADME","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/proffapt%2FmyREADME/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/proffapt%2FmyREADME/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/proffapt%2FmyREADME/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/proffapt","download_url":"https://codeload.github.com/proffapt/myREADME/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/proffapt%2FmyREADME/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272860976,"owners_count":25005521,"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","status":"online","status_checked_at":"2025-08-30T02:00:09.474Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["about-project","changelog","codeofconduct","contributing","github-about","github-actions","github-docs","github-docs-template","github-readme-example","github-readme-generator","github-readme-template","github-release-action","github-release-automation","github-release-workflow","github-releases","license","readme","readme-template","readymade-readme","security"],"created_at":"2024-10-09T18:54:39.143Z","updated_at":"2025-08-30T14:31:17.245Z","avatar_url":"https://github.com/proffapt.png","language":null,"readme":"\u003cdiv id=\"top\"\u003e\u003c/div\u003e\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links--\u003e\n\u003cdiv align=\"center\"\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n\u003c/div\u003e\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003c!-- UPDATE --\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/proffapt/PROJECT_NAME\"\u003e\n    \u003cimg width=\"140\" alt=\"image\" src=\"https://user-images.githubusercontent.com/86282911/206632284-cb260f57-c612-4ab5-b92b-2172c341ab23.png\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003ePROJECT_NAME\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n  \u003c!-- UPDATE --\u003e\n    \u003ci\u003eProject one liner slogan goes here\u003c/i\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/proffapt/PROJECT_NAME/issues\"\u003eRequest Feature | Report Bug\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n\u003csummary\u003eTable of Contents\u003c/summary\u003e\n\n- [About The Project](#about-the-project)\n  - [Supports](#supports)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n- [Usage](#usage)\n- [Contact](#contact)\n- [Acknowledgements](#acknowledgments)\n- [Additional documentation](#additional-documentation)\n\n\u003c/details\u003e\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\u003c!-- UPDATE --\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/proffapt/PROJECT_NAME\"\u003e\n    \u003cimg width=\"80%\" alt=\"image\" src=\"https://user-images.githubusercontent.com/86282911/206632547-a3b34b47-e7ae-4186-a1e6-ecda7ddb38e6.png\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n_Detailed explaination of the project goes here_\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003cdiv id=\"supports\"\u003e\u003c/div\u003e\n\n### Supports:\n1. Shells\n    * `bash`\n    * `fish`\n    * `zsh`\n2. OS(s)\n    * `MacOS`[`BSD` based]\n    * any `*nix`[`GNU+Linux` and `Unix`]\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nTo set up a local instance of the application, follow the steps below.\n\n### Prerequisites\n\u003c!-- UPDATE --\u003e\nThe following dependencies are required to be installed for the project to function properly:\n* npm\n  ```sh\n  npm install npm@latest -g\n  ```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Installation\n\n_Now that the environment has been set up and configured to properly compile and run the project, the next step is to install and configure the project locally on your system._\n\u003c!-- UPDATE --\u003e\n1. Clone the repository\n   ```sh\n   git clone https://github.com/proffapt/PROJECT_NAME.git\n   ```\n2. Make the script executable\n   ```sh\n   cd ./PROJECT_NAME\n   chmod +x ./PROJECT_NAME\n   ```\n3. Execute the script\n   ```sh\n   ./PROJECT_NAME\n   ```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\u003c!-- UPDATE --\u003e\nUse this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space.\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/proffapt/PROJECT_NAME\"\u003e\n    \u003cimg width=\"80%\" alt=\"image\" src=\"https://user-images.githubusercontent.com/86282911/206632640-40dc440e-5ef3-4893-be48-618f2bd85f37.png\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\n\u003cp\u003e\n📫 Arpit Bhardwaj ( aka proffapt ) -\n\u003ca href=\"https://twitter.com/proffapt\"\u003e\n  \u003cimg align=\"center\" alt=\"proffapt's Twitter \" width=\"22px\" src=\"https://raw.githubusercontent.com/edent/SuperTinyIcons/master/images/svg/twitter.svg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://t.me/proffapt\"\u003e\n  \u003cimg align=\"center\" alt=\"proffapt's Telegram\" width=\"22px\" src=\"https://raw.githubusercontent.com/edent/SuperTinyIcons/master/images/svg/telegram.svg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://www.linkedin.com/in/proffapt/\"\u003e\n  \u003cimg align=\"center\" alt=\"proffapt's LinkedIn\" width=\"22px\" src=\"https://raw.githubusercontent.com/edent/SuperTinyIcons/master/images/svg/linkedin.svg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"mailto:proffapt@pm.me\"\u003e\n  \u003cimg align=\"center\" alt=\"proffapt's mail\" width=\"22px\" src=\"https://raw.githubusercontent.com/edent/SuperTinyIcons/master/images/svg/mail.svg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://cybernity.group\"\u003e\n  \u003cimg align=\"center\" alt=\"proffapt's forum for cybernity\" width=\"22px\" src=\"https://cybernity.group/uploads/default/original/1X/a8338f86bbbedd39701c85d5f32cf3d817c04c27.png\" /\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n## Acknowledgments\n\n* [Choose an Open Source License](https://choosealicense.com)\n* [Img Shields](https://shields.io)\n\u003c!-- UPDATE --\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Additional documentation\n\n  - [Changelogs](/.github/CHANGELOG.md)\n  - [License](/LICENSE)\n  - [Security Policy](/.github/SECURITY.md)\n  - [Code of Conduct](/.github/CODE_OF_CONDUCT.md)\n  - [Contribution Guidelines](/.github/CONTRIBUTING.md)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/proffapt/PROJECT_NAME.svg?style=for-the-badge\n[contributors-url]: https://github.com/proffapt/PROJECT_NAME/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/proffapt/PROJECT_NAME.svg?style=for-the-badge\n[forks-url]: https://github.com/proffapt/PROJECT_NAME/network/members\n[stars-shield]: https://img.shields.io/github/stars/proffapt/PROJECT_NAME.svg?style=for-the-badge\n[stars-url]: https://github.com/proffapt/PROJECT_NAME/stargazers\n[issues-shield]: https://img.shields.io/github/issues/proffapt/PROJECT_NAME.svg?style=for-the-badge\n[issues-url]: https://github.com/proffapt/PROJECT_NAME/issues\n[license-shield]: https://img.shields.io/github/license/proffapt/PROJECT_NAME.svg?style=for-the-badge\n[license-url]: https://github.com/proffapt/PROJECT_NAME/blob/master/LICENSE\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://linkedin.com/in/proffapt\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproffapt%2Fmyreadme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fproffapt%2Fmyreadme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproffapt%2Fmyreadme/lists"}