README

安装组件

cd existing_repo
composer require kinsari/component

   adding to config/app
  'providers' => [
        //optional configuration
        Kinsari\Providers\KINCompoServiceProvider::class 

  ]

 php artisan vendor:publish --tag=kinsari/components --force

入门指南

为了帮助您快速开始使用GitLab，以下是一些推荐的下一步操作。

已经是专家？只需编辑此README.md文件，使其成为您的专属。想要更方便？使用底部的模板！

添加您的文件

[ ] [创建](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或上传文件
[ ] [使用命令行添加文件](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) 或使用以下命令推送现有的Git仓库

cd existing_repo
git remote add origin https://gitlab.com/munzambi.miguel/kinsari-component.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/munzambi.miguel/kinsari-component/-/settings/integrations)

与您的团队协作

[ ] [邀请团队成员和协作者](https://docs.gitlab.com/ee/user/project/members/)
[ ] [创建一个新的合并请求](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
[ ] [自动关闭合并请求中的问题](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
[ ] [启用合并请求审批](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
[ ] [在管道成功时自动合并](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

测试和部署

使用GitLab内置的持续集成。

[ ] [开始使用GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
[ ] [使用静态应用安全测试(SAST)分析代码中的已知漏洞](https://docs.gitlab.com/ee/user/application_security/sast/)
[ ] [使用自动部署将应用程序部署到Kubernetes、Amazon EC2或Amazon ECS](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
[ ] [使用基于拉取的部署来改进Kubernetes管理](https://docs.gitlab.com/ee/user/clusters/agent/)
[ ] [设置受保护的环境](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

编辑此README

当您准备好将此README作为您自己的时，只需编辑此文件并使用下面的便捷模板（或者您也可以自由地构建它 - 这只是一个起点！）。感谢 makeareadme.com 提供此模板。

良好的README建议

每个项目都不同，因此考虑哪些部分适用于您的情况。模板中使用的部分是针对大多数开源项目的建议。同时也要记住，虽然README可能太长或太详细，但过长总比过短好。如果您认为您的README太长，考虑利用另一种形式的文档，而不是删除信息。

名称

为您的项目选择一个具有自解释性的名称。

描述

让人们知道您的项目具体能做什么。提供上下文，并添加链接到任何可能不熟悉的参考。也可以在此处添加功能列表或背景子部分。如果有与您的项目不同的替代方案，这是一个列出不同点的良好位置。

徽章

在一些README中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用盾牌添加一些到您的README中。许多服务也提供了添加徽章的说明。

视觉元素

根据您正在制作的内容，包含截图甚至视频（您通常会看到GIF而不是实际视频）可能是一个好主意。像ttygif这样的工具可以帮助，但请查看Asciinema以获得更复杂的方法。

安装

在特定生态系统内，可能存在安装事物的常见方式，例如使用Yarn、NuGet或Homebrew。但是，请考虑阅读您的README的人可能是一名新手，并希望获得更多指导。列出具体步骤有助于消除歧义，并尽快让人们使用您的项目。如果它仅在特定环境中运行（如特定编程语言版本或操作系统）或需要手动安装依赖项，也请添加一个需求子部分。

使用

自由地使用示例，并在可能的情况下展示预期输出。在README中包含尽可能小的使用示例，同时提供指向更复杂示例的链接，如果它们太长而无法合理包含在README中，这很有帮助。

支持

告诉人们他们可以到哪里寻求帮助。可以是问题跟踪器、聊天室、电子邮件地址等任何组合。

路线图

如果您对未来发布有想法，将其列在README中是个好主意。

贡献

说明您是否接受贡献以及接受贡献的要求。

对于想要更改您项目的人来说，有一些关于如何开始的文档可能会有所帮助。可能有一个他们应该运行的脚本或一些需要设置的环境变量。明确这些步骤。这些说明也可能对您的未来自己有用。

您还可以记录用于检查代码或运行测试的命令。这些步骤有助于确保高代码质量并降低更改意外破坏某物的可能性。如果它需要外部设置（例如，在浏览器中测试时启动Selenium服务器），运行测试的说明特别有帮助。

作者和致谢

向为项目做出贡献的人表示感谢。

许可

对于开源项目，说明其许可方式。

项目状态

如果您已经耗尽了为项目提供能量或时间，请在README的顶部添加一个注释，说明开发已经放缓或完全停止。有人可能选择分支您的项目或志愿成为维护者或所有者，从而使项目继续进行。您还可以明确提出对维护者的请求。

kinsari / component

维护者

详细信息