History

Steve Ruiz 53a8fd6c69 Update readme (#2027 ) This PR updates the tldraw readme. ### Change Type - [x] `patch` — Bug fix		2023-10-06 12:10:33 +00:00
..
scripts	tldraw zero - package shuffle (#1710 )	2023-07-17 21:22:34 +00:00
src	Debugging cleanup / misc cleanup (#2025 )	2023-10-06 08:57:46 +00:00
api-extractor.json	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
api-report.md	[improvement] prevent editing in readonly (#1990 )	2023-10-03 11:03:01 +00:00
CHANGELOG.md	Update CHANGELOG.md [skip ci]	2023-06-28 11:53:57 +01:00
LICENSE	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
package.json	[fix] CSS reload in dev (#1791 )	2023-08-03 14:42:40 +00:00
README.md	Update readme (#2027 )	2023-10-06 12:10:33 +00:00
setupTests.js	avoid pixel rounding / transformation miscalc for overlay items (#1858 )	2023-09-08 10:47:14 +00:00
tsconfig.json	tldraw zero - package shuffle (#1710 )	2023-07-17 21:22:34 +00:00

README.md

@tldraw/tldraw

This is the pre-release version of tldraw.

See the pre-release docs at canary.tldraw.dev.

Installation

Install the @tldraw/tldraw package using @canary for the latest canary release. (Or @alpha for the latest alpha release.)

yarn add @tldraw/tldraw@canary
# or
npm install @tldraw/tldraw@canary
# or
pnpm i @tldraw/tldraw@canary

Then start the local development server.

yarn dev
# or
npm run dev
# or
pnpm dev

Usage

An extremely minimal usage (without our UI) might look like this:

import { Tldraw } from '@tldraw/tldraw'
import '@tldraw/tldraw/tldraw.css'

export default function () {
	return <Tldraw />
}

See the examples folder for more examples.

License

The source code in this repository (as well as our 2.0+ distributions and releases) are currently licensed under Apache-2.0. These licenses are subject to change in our upcoming 2.0 release. If you are planning to use tldraw in a commercial product, please reach out at hello@tldraw.com.