@ramme-io/ui 1.0.3 → 1.0.4

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
@@ -2,34 +2,27 @@
2
2
 
3
3
  [![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)
4
4
 
5
- **The structural frame for the modern web.**
5
+ **The blocks for the build kit.**
6
6
 
7
- Ramme UI is a curated bundle of industry-standard libraries, accessible components, and architectural best practices designed for rapid prototyping.
8
-
9
- 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.
7
+ Ramme UI is a basic bundle of standard, accessible components, and best practices ready for rapid prototyping.
10
8
 
11
9
  ---
12
10
 
13
- ## The Architecture
14
- 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.
11
+ ## The Basics
15
12
 
16
- We have orchestrated the most robust third-party libraries in the ecosystem into a single, opinionated toolkit:
13
+ We have collected popular third-party libraries into a single build kit:
17
14
 
18
15
  * **Engine:** React 19+
19
- * **Styling:** Tailwind CSS (configured for rapid iteration)
20
- * **Primitives:** Radix UI (for unstyled, accessible interactive elements)
21
- * **Motion:** Framer Motion (for high-fidelity interaction design)
16
+ * **Styling:** Tailwind CSS
17
+ * **Primitives:** Radix UI
18
+ * **Motion:** Framer Motion
22
19
  * **Icons:** Lucide React
23
20
 
24
- This is not a "walled garden." It is a standardized set of building materials that respects your need for speed and flexibility.
25
-
26
21
  ---
27
22
 
28
23
  ## Quick Start
29
24
 
30
- 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.
31
-
32
- Run the following command in your terminal:
25
+ To spin up a new project, run the initialization command in your terminal. This will generate a new folder with all resources linked and configured.
33
26
 
34
27
  *(Replace `my-new-project` with your desired folder name).*
35
28
 
@@ -41,11 +34,11 @@ This single command will:
41
34
  1. **Scaffold** a high-performance Vite project structure.
42
35
  2. **Install** React 19, TypeScript, and Tailwind CSS.
43
36
  3. **Configure** the `@ramme-io/ui` component library and design tokens.
44
- 4. **Optimize** linting and build settings for immediate deployment.
37
+ 4. **Optimize** limited configuration for customization.
45
38
 
46
39
  ---
47
40
 
48
- ## Launch Sequence
41
+ ## Getting Started
49
42
 
50
43
  Once the scaffolding is complete, initialize your local environment:
51
44
 
@@ -60,18 +53,18 @@ pnpm install
60
53
  # or npm install
61
54
  ```
62
55
 
63
- **3. Ignite the dev server**
56
+ **3. Start the dev server**
64
57
  ```bash
65
58
  pnpm run dev
66
59
  ```
67
60
 
68
- Your prototype is now live at `http://localhost:5173`.
61
+ Your prototype is running locally at `http://localhost:5173`.
69
62
 
70
63
  ---
71
64
 
72
65
  ## The Tech Stack
73
66
 
74
- This starter kit is not a proprietary framework; it is an opinionated orchestration of the best open-source tools available:
67
+ This starter kit is an opinionated selection of the best open-source tools available:
75
68
 
76
69
  * **Vite:** Next-generation tooling for instant server start and lightning-fast HMR (Hot Module Replacement).
77
70
  * **React:** The standard library for building composable user interfaces.
@@ -130,7 +123,7 @@ export default LandingPage;
130
123
 
131
124
  ## Local Development
132
125
 
133
- If you want to contribute to the framework or customize the primitives, you can run our component workbench locally.
126
+ If you want to contribute to the project or customize the primitives, you can run our component workbench locally.
134
127
 
135
128
  1. Install Dependencies:
136
129
 
@@ -145,18 +138,16 @@ pnpm run storybook
145
138
  ```
146
139
  ---
147
140
 
148
- ## The Ramme Ecosystem
149
-
150
- This tool is part of a suite of developer resources maintained by **Excesspool Limited Liability Company**:
141
+ ## Project Links
151
142
 
152
143
  * **`@ramme-io/ui`**: The core library of visual primitives.
153
- * **`@ramme-io/create-app`** (This Repository): The CLI scaffolding tool.
144
+ * **`@ramme-io/create-app`** (This Repository): The quick start kit.
154
145
 
155
146
  ---
156
147
 
157
148
  ## Contributing
158
149
 
159
- 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.
150
+ We welcome contributions from the community. Just fork the repository and submit a pull request. For major changes, please open an issue first to discuss.
160
151
 
161
152
  ## License
162
153
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ramme-io/ui",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "description": "The structural component library for the Ramme Framework.",
5
5
  "private": false,
6
6
  "main": "./dist/index.umd.js",