@gamecrafters/base-ui-icons 0.0.3 → 0.0.5

package/README.md

@@ -0,0 +1,143 @@
+<a id="readme-top"></a>
+
+
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+
+
+
+<br />
+<div align="center">
+  <a href="https://github.com/donaldturinglee/base-ui-icons">
+    <img src="public/logo.svg" alt="Logo" width="80" height="80">
+  </a>
+
+  <p align="center">
+    base-ui-icons are a set of SVG icons built by GameCrafters
+  </p>
+</div>
+
+
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
+
+
+## Getting Started
+
+To use the icons, install the published package. To work on the icon set itself,
+clone the repo and run the build pipeline locally.
+
+### Prerequisites
+
+* Node.js 24 or later
+* npm
+* React 18 or later, as a peer dependency of the package
+
+### Installation
+
+1. Install from npm
+   ```sh
+   npm install @gamecrafters/base-ui-icons
+   ```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+## Usage
+
+```jsx
+import { AddCircleRegular, AlertRegular } from '@gamecrafters/base-ui-icons/react'
+
+const Toolbar = () => {
+  return (
+    <button type="button">
+      <AddCircleRegular size={24} aria-label="Add item" />
+    </button>
+  )
+}
+```
+
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+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".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+### Top contributors:
+
+<a href="https://github.com/donaldturinglee/base-ui-icons/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=donaldturinglee/base-ui-icons" alt="contrib.rocks image" />
+</a>
+
+
+
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+## Contact
+
+Project Link: [https://github.com/donaldturinglee/base-ui-icons](https://github.com/donaldturinglee/base-ui-icons)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+[contributors-shield]: https://img.shields.io/github/contributors/donaldturinglee/base-ui-icons.svg?style=for-the-badge
+[contributors-url]: https://github.com/donaldturinglee/base-ui-icons/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/donaldturinglee/base-ui-icons.svg?style=for-the-badge
+[forks-url]: https://github.com/donaldturinglee/base-ui-icons/network/members
+[stars-shield]: https://img.shields.io/github/stars/donaldturinglee/base-ui-icons.svg?style=for-the-badge
+[stars-url]: https://github.com/donaldturinglee/base-ui-icons/stargazers
+[issues-shield]: https://img.shields.io/github/issues/donaldturinglee/base-ui-icons.svg?style=for-the-badge
+[issues-url]: https://github.com/donaldturinglee/base-ui-icons/issues
+[license-shield]: https://img.shields.io/github/license/donaldturinglee/base-ui-icons.svg?style=for-the-badge
+[license-url]: https://github.com/donaldturinglee/base-ui-icons/blob/main/LICENSE
+[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
+[React-url]: https://react.dev/
+[TypeScript]: https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white
+[TypeScript-url]: https://www.typescriptlang.org/
+[Rollup.js]: https://img.shields.io/badge/Rollup-EC4A3F?style=for-the-badge&logo=rollupdotjs&logoColor=white
+[Rollup-url]: https://rollupjs.org/
+[Node.js]: https://img.shields.io/badge/Node.js-5FA04E?style=for-the-badge&logo=nodedotjs&logoColor=white
+[Node-url]: https://nodejs.org/
+[SVGO]: https://img.shields.io/badge/SVGO-3E7FC1?style=for-the-badge&logo=svg&logoColor=white
+[SVGO-url]: https://github.com/svg/svgo