@dtinsight/react-icons 0.0.0-beta.9 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dtinsight/react-icons",
-  "version": "0.0.0-beta.9",
+  "version": "1.1.0",
   "description": "",
   "main": "dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -41,5 +41,5 @@
     "website:build": "pnpm build && pnpm --filter website build",
     "website:deploy": "node scripts/deploy.js"
   },
-  "readme": "# dtstack_iconCollections\n\n\n\n## Getting started\n\nTo make it easy for you to get started with GitLab, here's a list of recommended next steps.\n\nAlready a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!\n\n## Add your files\n\n- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files\n- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:\n\n```\ncd existing_repo\ngit remote add origin http://gitlab.prod.dtstack.cn/dt-insight-front/infrastructure/dtstack_iconcollections.git\ngit branch -M main\ngit push -uf origin main\n```\n\n## Integrate with your tools\n\n- [ ] [Set up project integrations](http://gitlab.prod.dtstack.cn/dt-insight-front/infrastructure/dtstack_iconcollections/-/settings/integrations)\n\n## Collaborate with your team\n\n- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)\n- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)\n- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)\n- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)\n- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)\n\n## Test and Deploy\n\nUse the built-in continuous integration in GitLab.\n\n- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)\n- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)\n- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)\n- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)\n- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)\n\n***\n\n# Editing this README\n\nWhen you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.\n\n## Suggestions for a good README\n\nEvery project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.\n\n## Name\nChoose a self-explaining name for your project.\n\n## Description\nLet people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.\n\n## Badges\nOn some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.\n\n## Visuals\nDepending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.\n\n## Installation\nWithin a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.\n\n## Usage\nUse examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.\n\n## Support\nTell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.\n\n## Roadmap\nIf you have ideas for releases in the future, it is a good idea to list them in the README.\n\n## Contributing\nState if you are open to contributions and what your requirements are for accepting them.\n\nFor people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.\n\nYou can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.\n\n## Authors and acknowledgment\nShow your appreciation to those who have contributed to the project.\n\n## License\nFor open source projects, say how it is licensed.\n\n## Project status\nIf you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.\n"
+  "readme": "# dtstack_iconCollections\n\ndtstack_iconCollections 是一个基于 React + TypeScript 的图标集合库，支持 tsup 构建，适用于前端项目的图标快速集成与管理。\n\n## 项目简介\n\n- 提供丰富的 SVG 图标组件，便于在 React 项目中直接引用。\n- 支持自动化生成与持续集成，保证图标库的及时更新。\n- 采用 pnpm 进行包管理，提升依赖安装效率。\n\n## 目录结构\n\n```\n├── src/                # 主库源码\n│   ├── icons/          # 图标组件（TSX 格式）\n│   ├── svg/            # 原始 SVG 文件\n│   ├── constant.ts     # 常量定义\n│   └── index.ts        # 入口文件\n├── website/            # 组件预览与文档站点\n│   ├── public/\n│   └── src/\n├── scripts/            # 辅助脚本（如自动生成图标）\n├── .gitlab-ci.yml      # GitLab CI/CD 配置\n├── package.json        # 项目依赖与脚本\n└── README.md           # 项目说明文档\n```\n\n## 安装\n\n```sh\npnpm add @dtinsight/react-icons\n```\n\n## 使用方法\n\n在 React 项目中引入图标组件：\n\n```tsx\nimport { AiAvatarColored } from '@dtinsight/react-icons';\n\nfunction App() {\n  return <AiAvatarColored />;\n}\n```\n\n## 本地开发\n\n1. 安装依赖：\n\n    ```sh\n    pnpm install\n    cd website\n    pnpm install\n    ```\n\n2. 启动文档站点（预览所有图标）：\n\n    ```sh\n    pnpm website:dev\n    ```\n\n3. 自动生成图标组件：\n    ```sh\n    pnpm run generate\n    ```\n\n## 持续集成\n\n本项目已配置 GitLab CI/CD，自动完成依赖安装、图标生成、构建与发布。详见 [.gitlab-ci.yml](.gitlab-ci.yml)。\n\n本项目的所有 icon 通过 [figma 插件](https://gitlab.prod.dtstack.cn/dt-insight-front/infrastructure/figma-icon-plugin) 获取而来，从而完成 GitLab CI/CD\n\n## 贡献指南\n\n1. Fork 本仓库并新建分支。\n2. 提交代码前请运行 `pnpm run generate` 保证图标组件最新。\n3. 提交合并请求（MR）。\n\n## License\n\nMIT\n\n---\n\n如需更多帮助或有任何建议，欢迎提 Issue 或 PR！"
 }