opui-css 1.2.4 → 1.2.6

package/README.md

@@ -1,59 +1,25 @@
-# ui-css
+# Open Props UI
 
-Lightweight, CSS component library. Ships plain CSS with a prebuilt bundle and full source files.
+A CSS UI library exploring how next-gen HTML & CSS features can change the way we create components. Designed to be used by professional teams as well as tinkering hobbyists. Everything is made with **ease-of-use** and **scalability** in mind. Last but not least - you **copy and paste** the components into your repo. It's the best way to have a complete **understanding** and **ownership** over your stuff.
 
-## Install
+https://open-props-ui.netlify.app/
 
-Use your preferred package manager:
+## Getting started
 
-```bash
-pnpm add ui-css
-# or
-npm install ui-css
-# or
-yarn add ui-css
-```
+Check out the [getting started guide](https://open-props-ui.netlify.app/guide/getting-started.html).
 
-## Usage
+## Backstory
 
-- Quick start (single bundle):
+Practically all established UI libraries need to take older browser versions into account. Some have only just dropped Internet Explorer. Some have barely discovered the power of CSS grid. Open Props UI starts from a blank slate and re-imagines how a component library could be built if you used the most modern features.
 
-Import the prebuilt stylesheet in your app entry or HTML:
+## The goal of the component library
 
-```css
-/* app.css */
-@import "ui-css/dist/ui.css";
-```
+> "If you only use the latest features, that means this is can never enter production"
 
-Or in JS/TS (bundlers like Vite, Webpack, Next.js):
+Yes and no. Right now that's true for most components. The point is to let the spec and the components mature alongside each other and in time the library will be ready for production.
 
-```ts
-import "ui-css/dist/ui.css";
-```
-
-- Granular usage (raw sources):
-
-If you have PostCSS or a bundler handling CSS imports, you can import from `src` to tree-pick only what you need:
-
-```css
-@import "ui-css/src/normalize.css";
-@import "ui-css/src/theme.css";
-@import "ui-css/src/components/button.css";
-/* ... */
-```
-
-## Exports
-
-- `"ui-css"` and `"ui-css/dist/ui.css"` point to the prebuilt CSS bundle.
-- `"ui-css/dist/*"` exposes all built files in `dist/`.
-- `"ui-css/src/*"` exposes the raw, unprocessed sources for advanced setups.
-
-## Publishing
-
-The package auto-builds before publish via `prepublishOnly`. To publish:
-
-```bash
-pnpm publish --access public
-```
-
-Ensure you are logged in to npm and have the proper permissions.
+- Have sensible defaults without sacrificing flexibility and control
+- Use modern HTML & CSS features
+- Follow accessibility guidelines
+- Serve as an inspiration
+- Be scalable