@ansiversa/components 0.0.2 → 0.0.3

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 +17 -26
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,35 +1,26 @@
1
- # Astro Starter Kit: Component Package
1
+ # 📦 @ansiversa/components
2
2
 
3
- This is a template for an Astro component library. Use this template for writing components to use in multiple projects or publish to NPM.
3
+ Shared UI Components & Layouts for the **Ansiversa Ecosystem** a collection of premium, consistent, reusable Astro components designed for all Ansiversa apps including **Web**, **Admin**, and all future **100+ Mini Apps**.
4
4
 
5
- ```sh
6
- npm create astro@latest -- --template component
7
- ```
5
+ This package ensures that every app in the ecosystem uses the same styles, layouts, and interaction patterns for a unified experience.
8
6
 
9
- [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/non-html-pages)
10
- [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/non-html-pages)
11
- [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/component/devcontainer.json)
7
+ ---
12
8
 
13
- ## 🚀 Project Structure
9
+ ## 🚀 Features
14
10
 
15
- Inside of your Astro project, you'll see the following folders and files:
11
+ - ⚡️ Reusable Astro Components (Buttons, Cards, Inputs, Navbar, Footer)
12
+ - 🧱 Shared Layouts (WebLayout, AuthLayout)
13
+ - 🎨 Design-System Ready (works with Ansiversa global.css tokens)
14
+ - 🌙 Fully compatible with light/dark mode
15
+ - 🧩 Plug-and-play installation for any Ansiversa mini-app
16
+ - 📦 Distributed as a clean NPM package
17
+ - 🛠 Perfect for Astro projects with or without Alpine.js
16
18
 
17
- ```text
18
- /
19
- ├── index.ts
20
- ├── src
21
- │ └── MyComponent.astro
22
- ├── tsconfig.json
23
- ├── package.json
24
- ```
19
+ ---
25
20
 
26
- The `index.ts` file is the "entry point" for your package. Export your components in `index.ts` to make them importable from your package.
21
+ ## 📥 Installation
27
22
 
28
- ## 🧞 Commands
23
+ Inside any Ansiversa app (`web`, `admin`, or mini-apps):
29
24
 
30
- All commands are run from the root of the project, from a terminal:
31
-
32
- | Command | Action |
33
- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34
- | `npm link` | Registers this package locally. Run `npm link my-component-library` in an Astro project to install your components |
35
- | `npm publish` | [Publishes](https://docs.npmjs.com/creating-and-publishing-unscoped-public-packages#publishing-unscoped-public-packages) this package to NPM. Requires you to be [logged in](https://docs.npmjs.com/cli/v8/commands/npm-adduser) |
25
+ ```bash
26
+ npm install @ansiversa/components
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ansiversa/components",
3
- "version": "0.0.2",
3
+ "version": "0.0.3",
4
4
  "description": "Shared UI components and layouts for the Ansiversa ecosystem",
5
5
  "type": "module",
6
6
  "exports": {