@vini-wine/core-enums 1.0.0

package/README.md

@@ -0,0 +1,54 @@
+# @vini-wine/core-enums
+
+This package provides core enums for the Vini frontend, designed to support TypeScript. It includes various enums essential for the Vini frontend.
+
+## Installation
+
+To install the package in your project, you can use npm or yarn. In your project directory, run one of the following commands:
+
+```bash
+# Using npm
+npm install @vini-wine/core-enums
+```
+```bash
+# Using yarn
+yarn add @vini-wine/core-enums
+```
+
+## Usage
+### Importing Enums in TypeScript
+In your TypeScript files, you can import the enums from the package as needed. Here's an example:
+
+```typescript
+import {
+    FirstEnum,
+    SecondEnum,
+    ThirdEnum,
+    // ... other enums
+} from "@vini-wine/core-enums";
+```
+
+### Usage in Your Application
+Once you have imported the enums into your project, you can use them as needed. Here's an example of how to use the enums in your application:
+
+```typescript
+import {
+    FirstEnum,
+    SecondEnum,
+    ThirdEnum,
+    // ... other enums
+} from "@vini-wine/core-enums";
+
+// Use the enums in your application logic
+const myValue = FirstEnum.VALUE_ONE;
+
+// ... more examples based on your specific enums
+```
+
+### Scripts
+The package includes the following npm scripts:
+
+- build: Run tsup to build the project.
+- test: Placeholder for running tests (not specified).
+- lint: Run ESLint for linting with TypeScript support.
+- format: Use Prettier to format code.