@igraal/web-design-system 0.0.1-security → 3.677.2

package/README.md

@@ -1,5 +1,39 @@
-# Security holding package
+# @igraal/web-design-system
 
-This package contained malicious code and was removed from the registry by the npm security team. A placeholder was published to ensure users are not affected in the future.
+Igraal design system based on React components.
 
-Please refer to www.npmjs.com/advisories?search=%40igraal%2Fweb-design-system for more information.
+## Features
+
+- ES6 syntax, managed with Prettier + Eslint and Stylelint
+- Unit testing via Jest
+- React v17
+- ESM
+
+## Install
+
+```sh
+yarn add @igraal/web-design-system
+// or
+npm i @igraal/web-design-system
+```
+
+### Requirements
+
+- Node.js `v12.x` or later
+
+
+### Usage
+
+```js
+import { useModal } from '@igraal/web-design-system';
+
+const App = () => {
+  const [Modal, openModal] = useModal();
+  return (
+    <div>
+      <button onClick={() => openModal(true)}>Open modal</button>
+      <Modal>This is inside a modal</Modal>
+    </div>
+  );
+}
+```