aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authornetop://ウィビ <paul@webb.page>2026-04-25 12:43:18 -0700
committernetop://ウィビ <paul@webb.page>2026-04-25 12:43:18 -0700
commitcbc9a7d577e9e09945b461e3ce1e7ad5bbc9fedd (patch)
tree8040af555bbb9645b2d7658d568af144a12ee5f3 /README.md
parentc02e1ef88dcba5841ffdf0d6f09a4f7cf5266ce1 (diff)
downloaduchu-cbc9a7d577e9e09945b461e3ce1e7ad5bbc9fedd.tar.gz
uchu-cbc9a7d577e9e09945b461e3ce1e7ad5bbc9fedd.zip
updates README to match new scoped package name
- further updates to documentation I forgot to do
Diffstat (limited to '')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 13bb5ea..9ffe8d9 100644
--- a/README.md
+++ b/README.md
@@ -9,8 +9,8 @@ No, [I will not add other color spaces](./documentation/FAQ.md#normal-colors).
## Install
```sh
-bun add uchu
-# or: npm install uchu / pnpm add uchu / yarn add uchu
+bun add @inc/uchu
+# or: npm install @inc/uchu / pnpm add @inc/uchu / yarn add @inc/uchu
```
@@ -20,7 +20,7 @@ bun add uchu
### JavaScript / TypeScript
```ts
-import { color, palette, reduced, yang } from "uchu";
+import { color, palette, reduced, yang } from "@inc/uchu";
palette.blue[5]; // "oklch(54.87% 0.222 260.33)"
color("red", 7); // "oklch(49.95% 0.195 18.34)"
@@ -35,7 +35,7 @@ Types `Hue` and `Shade` are exported for narrowing palette keys.
Drop the stylesheet in and use the CSS custom properties:
```ts
-import "uchu/css";
+import "@inc/uchu/css";
```
```css
@@ -49,7 +49,7 @@ body {
### Sass / SCSS
```scss
-@use "uchu/scss" as *;
+@use "@inc/uchu/scss" as *;
body {
background-color: $uchu-yang;