tldraw

No description

Find a file

Steve Ruiz e542f1fde5 Update READMEs (#290 ) * Update readmes * tweak links * Update README.md		2021-11-18 15:07:55 +00:00
.github	[big chore] restore core to monorepo (#287 )	2021-11-18 13:09:18 +00:00
.husky	[mega-chore] renaming (#223 )	2021-11-06 11:16:30 +00:00
.vscode	big refactor	2021-09-13 16:38:42 +01:00
apps	Update READMEs (#290 )	2021-11-18 15:07:55 +00:00
examples	Update READMEs (#290 )	2021-11-18 15:07:55 +00:00
packages	Update READMEs (#290 )	2021-11-18 15:07:55 +00:00
.eslintignore	Prepare for Publishing VS Code Extension (#227 )	2021-11-10 15:35:51 +00:00
.eslintrc	Prepare for Publishing VS Code Extension (#227 )	2021-11-10 15:35:51 +00:00
.gitignore	[big chore] restore core to monorepo (#287 )	2021-11-18 13:09:18 +00:00
.npmignore	Replace	2021-08-10 17:12:55 +01:00
.prettierrc	Prepare for Publishing VS Code Extension (#227 )	2021-11-10 15:35:51 +00:00
card-repo.png	[improvement] repo shuffle (#214 )	2021-11-02 11:46:25 +00:00
CODE_OF_CONDUCT.md	updates docs / readmes / adds contributor guide	2021-11-11 12:11:21 +00:00
CONTRIBUTING.md	1.0.0 (#267 )	2021-11-16 16:01:29 +00:00
lerna.json	v1.0.3	2021-11-17 11:50:57 +00:00
LICENSE.md	[improvement] UI (#215 )	2021-11-03 16:46:33 +00:00
package.json	update readmes	2021-11-18 14:05:44 +00:00
README.md	Update READMEs (#290 )	2021-11-18 15:07:55 +00:00
setupTests.ts	Adjusts small example, makes inputs unique to each instance	2021-09-08 17:18:43 +01:00
tsconfig.base.json	update readmes	2021-11-18 14:05:44 +00:00
tsconfig.json	[big chore] restore core to monorepo (#287 )	2021-11-18 13:09:18 +00:00
yarn.lock	[big chore] restore core to monorepo (#287 )	2021-11-18 13:09:18 +00:00

README.md

Welcome to the tldraw monorepo. Here you'll find the source code for @tldraw/tldraw, @tldraw/core, and the tldraw.com website.

🙌 Questions? Join the Discord channel or start a discussion.

💕 Love this project? Consider becoming a sponsor.

This repository is a monorepo containing two packages:

packages/tldraw contains the source for the @tldraw/tldraw package. This is an editor as a React component named <Tldraw>. You can use this package to embed the tldraw editor in any React application.
packages/core contains the source for the @tldraw/core package. This is a renderer for React components in a canvas-style UI. It is used by @tldraw/tldraw as well as several other projects.

...and three apps:

apps/www contains the source for the tldraw.com website.
apps/vscode contains the source for the tldraw VS Code extension.
apps/electron contains the source for an experimental Electron app.

...and three examples:

examples/core-example is a simple example for @tldraw/core.
examples/core-example-advanced is a second example for @tldraw/core.
examples/tldraw-example is an example for @tldraw/tldraw.

Contribution

See the contributing guide.

Support

Need help? Please open an issue for support.

Discussion

Want to connect with other devs? Visit the Discord channel.

License

This project is licensed under MIT.

If you're using the library in a commercial product, please consider becoming a sponsor.

Author

@steveruizok