docs: install from the v1.0.0 release tarball on git.dreamodus.software
This commit is contained in:
parent
54d006b137
commit
5556c98d7f
5 changed files with 28 additions and 9 deletions
10
README.md
10
README.md
|
|
@ -43,9 +43,15 @@ import { MetalKnob, LEDKnob, Fader, logTaper } from 'dreamknob'
|
|||
|
||||
See `packages/dreamknob/README.md` and the docs app for the full API.
|
||||
|
||||
## Using it in another app (without publishing)
|
||||
## Using it in another app
|
||||
|
||||
The package builds to `packages/dreamknob/dist` (ESM + CJS + types). Three options:
|
||||
The easiest way is the published release on our Forgejo:
|
||||
|
||||
```bash
|
||||
pnpm add https://git.dreamodus.software/Dreamodus/DreamKnob/releases/download/v1.0.0/dreamknob-1.0.0.tgz
|
||||
```
|
||||
|
||||
Or build locally — the package builds to `packages/dreamknob/dist` (ESM + CJS + types):
|
||||
|
||||
```bash
|
||||
# 1. Tarball (most robust — behaves exactly like an npm install)
|
||||
|
|
|
|||
|
|
@ -29,10 +29,16 @@ export const GettingStarted: React.FC = () => (
|
|||
</p>
|
||||
|
||||
<Step n={1} title="Install">
|
||||
<CodeBlock code={`npm install dreamknob\n# peer deps: react >= 18, react-dom >= 18`} />
|
||||
<CodeBlock
|
||||
code={`pnpm add https://git.dreamodus.software/Dreamodus/DreamKnob/releases/download/v1.0.0/dreamknob-1.0.0.tgz\n# (or npm install <same url>) · peer deps: react >= 18, react-dom >= 18`}
|
||||
/>
|
||||
<p className="api-note" style={{ marginTop: 10 }}>
|
||||
Zero runtime dependencies, ESM + CJS, full TypeScript types. No CSS file to
|
||||
import — everything is SVG and inline styles.
|
||||
Installs straight from the{' '}
|
||||
<a href="https://git.dreamodus.software/Dreamodus/DreamKnob/releases">
|
||||
v1.0.0 release
|
||||
</a>{' '}
|
||||
on our Forgejo. Zero runtime dependencies, ESM + CJS, full TypeScript types. No
|
||||
CSS file to import — everything is SVG and inline styles.
|
||||
</p>
|
||||
</Step>
|
||||
|
||||
|
|
|
|||
|
|
@ -25,10 +25,10 @@ export const Hero: React.FC = () => {
|
|||
range, any decimal precision, and colors you fully control.
|
||||
</p>
|
||||
<div className="install">
|
||||
<span>pnpm add dreamknob</span>
|
||||
<span>pnpm add https://git.dreamodus.software/Dreamodus/DreamKnob/releases/download/v1.0.0/dreamknob-1.0.0.tgz</span>
|
||||
<button
|
||||
onClick={() => {
|
||||
navigator.clipboard.writeText('pnpm add dreamknob');
|
||||
navigator.clipboard.writeText('pnpm add https://git.dreamodus.software/Dreamodus/DreamKnob/releases/download/v1.0.0/dreamknob-1.0.0.tgz');
|
||||
setCopied(true);
|
||||
setTimeout(() => setCopied(false), 1400);
|
||||
}}
|
||||
|
|
|
|||
|
|
@ -178,9 +178,14 @@ body {
|
|||
padding: 10px 16px;
|
||||
border-radius: 10px;
|
||||
font-family: var(--font-mono);
|
||||
font-size: 14px;
|
||||
font-size: 13px;
|
||||
color: var(--accent-2);
|
||||
position: relative;
|
||||
max-width: calc(100% - 32px);
|
||||
}
|
||||
.hero .install span {
|
||||
word-break: break-all;
|
||||
text-align: left;
|
||||
}
|
||||
.hero .install button {
|
||||
background: none;
|
||||
|
|
|
|||
|
|
@ -5,9 +5,11 @@ headless core, any number range, any decimal precision, and colors you fully con
|
|||
Zero runtime dependencies.
|
||||
|
||||
```
|
||||
npm install dreamknob
|
||||
pnpm add https://git.dreamodus.software/Dreamodus/DreamKnob/releases/download/v1.0.0/dreamknob-1.0.0.tgz
|
||||
```
|
||||
|
||||
(Latest release tarballs: https://git.dreamodus.software/Dreamodus/DreamKnob/releases)
|
||||
|
||||
## Quick start
|
||||
|
||||
```tsx
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue