Merge pull request #1 from SigNoz/icons-initial-setup

feat: initial setup for icons library

.babelrc

@@ -0,0 +1,3 @@
+{
+    "presets": [["@babel/preset-env", { "targets": "defaults" }], "@babel/preset-react"]
+}

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+src

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 SigNoz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+2. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,73 @@
-# icons
+# @signoz/icons
+
+## Description
+
+`@signoz/icons` is a collection of SVG-based React icon components. This package provides a set of customizable icons that can be easily integrated into your React projects.
+
+## Features
+
+- SVG-based icons for high-quality rendering
+- Customizable via React props
+- Easy integration with React projects
+
+## Installation
+
+To install the package, use npm:
+
+```bash
+npm install @signoz/icons
+```
+
+## Usage
+
+To use an icon in your project, import it from the package and include it in your component:
+
+```jsx
+import { IconName } from '@signoz/icons';
+
+const MyComponent = () => (
+  <IconName />
+);
+```
+
+Replace `IconName` with the actual name of the icon you want to use.
+
+## Scripts
+
+The following scripts are available in the package:
+
+- `prebuild`: Cleans the `src` and `dist` directories using `rimraf`.
+- `build`: Runs the `svgr` script and then builds the project using `rollup`.
+- `svgr`: Converts SVG files to React components with specific options.
+
+To run these scripts, use npm:
+
+```bash
+npm run prebuild
+npm run build
+npm run svgr
+```
+
+## Development
+
+### Prerequisites
+
+Make sure you have the following installed:
+
+- Node.js
+- npm
+
+### Building the Project
+
+To build the project, run:
+
+```bash
+npm run build
+```
+
+This will generate the `dist` directory with the compiled files.
+
+### Contributing
+
+We welcome contributions to this package. If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
+