@ramme-io/ui 1.0.2 → 1.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Excesspool Limited Liability Company
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

package/README.md

@@ -1,18 +1,35 @@
-# Ramme App Starter
+# Ramme UI
 
-[![NPM Version](https://img.shields.io/npm/v/@ramme-io/create-app.svg)](https://www.npmjs.com/package/@ramme-io/create-app) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![NPM Version](https://img.shields.io/npm/v/@ramme-io/create-app.svg)](https://www.npmjs.com/package/@ramme-io/ui) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**The clean-room environment for modern product design.**
+**The structural frame for the modern web.**
 
-This repository is the official scaffolding tool for the Ramme ecosystem. It automates the setup of a production-grade frontend environment, pre-wiring the **Ramme UI** component library with the industry's most robust open-source technologies.
+Ramme UI is a curated bundle of industry-standard libraries, accessible components, and architectural best practices designed for rapid prototyping.
 
-Designed for speed and structural integrity, this starter kit removes the friction of configuration so you can move from concept to interactive prototype in seconds.
+It creates a "Golden Path" for product designers and engineers who need to validate ideas quickly without getting bogged down in configuration. By bundling the best open-source tools into a cohesive system, Ramme allows you to build high-fidelity, interactive prototypes that are production-ready from day one.
+
+---
+
+## The Architecture
+Ramme (Danish for "Frame") is not about reinventing the wheel. It is about providing a solid steel frame so you can focus on the walls and windows.
+
+We have orchestrated the most robust third-party libraries in the ecosystem into a single, opinionated toolkit:
+
+* **Engine:** React 19+
+* **Styling:** Tailwind CSS (configured for rapid iteration)
+* **Primitives:** Radix UI (for unstyled, accessible interactive elements)
+* **Motion:** Framer Motion (for high-fidelity interaction design)
+* **Icons:** Lucide React
+
+This is not a "walled garden." It is a standardized set of building materials that respects your need for speed and flexibility.
 
 ---
 
 ## Quick Start
 
-To scaffold a new project, run the initialization command in your terminal. This will generate a fresh directory with all dependencies linked and configured.
+The fastest way to start building is to use our CLI tool, which scaffolds a Vite-powered application with the Ramme Design System pre-configured.
+
+Run the following command in your terminal:
 
 *(Replace `my-new-project` with your desired folder name).*
 
@@ -64,6 +81,70 @@ This starter kit is not a proprietary framework; it is an opinionated orchestrat
 
 ---
 
+## Manual Installation
+
+If you are adding Ramme to an existing project, install the core package:
+
+```bash
+npm install @ramme-io/ui
+# or
+pnpm add @ramme-io/ui
+```
+
+---
+
+## Component Usage
+
+Ramme components are designed to be composable and intuitive.
+
+```tsx
+import React from 'react';
+import { Button, Card, PageHeader } from '@ramme-io/ui';
+import { ArrowRight } from 'lucide-react';
+
+function LandingPage() {
+  return (
+    <div className="p-8 max-w-4xl mx-auto">
+      <PageHeader
+        title="Prototype Faster."
+        description="Stop fighting with config files. Start designing in code."
+      />
+      
+      <Card className="mt-8 p-6 border-neutral-200 shadow-sm">
+        <h3 className="text-lg font-medium mb-2">Ready to build?</h3>
+        <p className="text-neutral-600 mb-6">
+          This component is accessible, responsive, and themable by default.
+        </p>
+        <Button variant="default" onClick={() => console.log('Launch')}>
+          Initialize Project <ArrowRight className="ml-2 h-4 w-4" />
+        </Button>
+      </Card>
+    </div>
+  );
+}
+
+export default LandingPage;
+```
+
+---
+
+## Local Development
+
+If you want to contribute to the framework or customize the primitives, you can run our component workbench locally.
+
+1. Install Dependencies:
+
+```bash
+pnpm install
+```
+
+2. Run Storybook: This starts the local development environment where you can test components in isolation.
+
+```bash
+pnpm run storybook
+```
+---
+
 ## The Ramme Ecosystem
 
 This tool is part of a suite of developer resources maintained by **Excesspool Limited Liability Company**:
@@ -73,6 +154,10 @@ This tool is part of a suite of developer resources maintained by **Excesspool L
 
 ---
 
+## Contributing
+
+We welcome contributions from the community. Please fork the repository and submit a pull request. For major architectural changes, please open an issue first to discuss the proposed direction.
+
 ## License
 
 Copyright © 2025 Excesspool Limited Liability Company.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ramme-io/ui",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "The structural component library for the Ramme Framework.",
   "private": false,
   "main": "./dist/index.umd.js",