@gamecrafters/base-ui-icons 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +143 -0
  2. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,143 @@
1
+ <a id="readme-top"></a>
2
+
3
+
4
+
5
+ [![Contributors][contributors-shield]][contributors-url]
6
+ [![Forks][forks-shield]][forks-url]
7
+ [![Stargazers][stars-shield]][stars-url]
8
+ [![Issues][issues-shield]][issues-url]
9
+ [![MIT License][license-shield]][license-url]
10
+
11
+
12
+
13
+ <br />
14
+ <div align="center">
15
+ <a href="https://github.com/donaldturinglee/base-ui-icons">
16
+ <img src="public/logo.svg" alt="Logo" width="80" height="80">
17
+ </a>
18
+
19
+ <p align="center">
20
+ base-ui-icons are a set of SVG icons built by GameCrafters
21
+ </p>
22
+ </div>
23
+
24
+
25
+
26
+ <details>
27
+ <summary>Table of Contents</summary>
28
+ <ol>
29
+ <li>
30
+ <a href="#getting-started">Getting Started</a>
31
+ <ul>
32
+ <li><a href="#prerequisites">Prerequisites</a></li>
33
+ <li><a href="#installation">Installation</a></li>
34
+ </ul>
35
+ </li>
36
+ <li><a href="#usage">Usage</a></li>
37
+ <li><a href="#roadmap">Roadmap</a></li>
38
+ <li><a href="#contributing">Contributing</a></li>
39
+ <li><a href="#license">License</a></li>
40
+ <li><a href="#contact">Contact</a></li>
41
+ </ol>
42
+ </details>
43
+
44
+
45
+ ## Getting Started
46
+
47
+ To use the icons, install the published package. To work on the icon set itself,
48
+ clone the repo and run the build pipeline locally.
49
+
50
+ ### Prerequisites
51
+
52
+ * Node.js 24 or later
53
+ * npm
54
+ * React 18 or later, as a peer dependency of the package
55
+
56
+ ### Installation
57
+
58
+ 1. Install from npm
59
+ ```sh
60
+ npm install @gamecrafters/base-ui-icons
61
+ ```
62
+
63
+ <p align="right">(<a href="#readme-top">back to top</a>)</p>
64
+
65
+
66
+
67
+ ## Usage
68
+
69
+ ```jsx
70
+ import { AddCircleRegular, AlertRegular } from '@gamecrafters/base-ui-icons/react'
71
+
72
+ const Toolbar = () => {
73
+ return (
74
+ <button type="button">
75
+ <AddCircleRegular size={24} aria-label="Add item" />
76
+ </button>
77
+ )
78
+ }
79
+ ```
80
+
81
+
82
+ <p align="right">(<a href="#readme-top">back to top</a>)</p>
83
+
84
+
85
+ ## Contributing
86
+
87
+ Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
88
+
89
+ If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
90
+ Don't forget to give the project a star! Thanks again!
91
+
92
+ 1. Fork the Project
93
+ 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
94
+ 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
95
+ 4. Push to the Branch (`git push origin feature/AmazingFeature`)
96
+ 5. Open a Pull Request
97
+
98
+ <p align="right">(<a href="#readme-top">back to top</a>)</p>
99
+
100
+ ### Top contributors:
101
+
102
+ <a href="https://github.com/donaldturinglee/base-ui-icons/graphs/contributors">
103
+ <img src="https://contrib.rocks/image?repo=donaldturinglee/base-ui-icons" alt="contrib.rocks image" />
104
+ </a>
105
+
106
+
107
+
108
+ ## License
109
+
110
+ Distributed under the MIT License. See `LICENSE` for more information.
111
+
112
+ <p align="right">(<a href="#readme-top">back to top</a>)</p>
113
+
114
+
115
+
116
+ ## Contact
117
+
118
+ Project Link: [https://github.com/donaldturinglee/base-ui-icons](https://github.com/donaldturinglee/base-ui-icons)
119
+
120
+ <p align="right">(<a href="#readme-top">back to top</a>)</p>
121
+
122
+
123
+
124
+ [contributors-shield]: https://img.shields.io/github/contributors/donaldturinglee/base-ui-icons.svg?style=for-the-badge
125
+ [contributors-url]: https://github.com/donaldturinglee/base-ui-icons/graphs/contributors
126
+ [forks-shield]: https://img.shields.io/github/forks/donaldturinglee/base-ui-icons.svg?style=for-the-badge
127
+ [forks-url]: https://github.com/donaldturinglee/base-ui-icons/network/members
128
+ [stars-shield]: https://img.shields.io/github/stars/donaldturinglee/base-ui-icons.svg?style=for-the-badge
129
+ [stars-url]: https://github.com/donaldturinglee/base-ui-icons/stargazers
130
+ [issues-shield]: https://img.shields.io/github/issues/donaldturinglee/base-ui-icons.svg?style=for-the-badge
131
+ [issues-url]: https://github.com/donaldturinglee/base-ui-icons/issues
132
+ [license-shield]: https://img.shields.io/github/license/donaldturinglee/base-ui-icons.svg?style=for-the-badge
133
+ [license-url]: https://github.com/donaldturinglee/base-ui-icons/blob/main/LICENSE
134
+ [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
135
+ [React-url]: https://react.dev/
136
+ [TypeScript]: https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white
137
+ [TypeScript-url]: https://www.typescriptlang.org/
138
+ [Rollup.js]: https://img.shields.io/badge/Rollup-EC4A3F?style=for-the-badge&logo=rollupdotjs&logoColor=white
139
+ [Rollup-url]: https://rollupjs.org/
140
+ [Node.js]: https://img.shields.io/badge/Node.js-5FA04E?style=for-the-badge&logo=nodedotjs&logoColor=white
141
+ [Node-url]: https://nodejs.org/
142
+ [SVGO]: https://img.shields.io/badge/SVGO-3E7FC1?style=for-the-badge&logo=svg&logoColor=white
143
+ [SVGO-url]: https://github.com/svg/svgo
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gamecrafters/base-ui-icons",
3
- "version": "0.0.4",
3
+ "version": "0.0.5",
4
4
  "description": "",
5
5
  "main": "./lib/react/index.js",
6
6
  "module": "./lib/react/index.mjs",