PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

updatereadmes

Browse source
This commit is contained in:
Steve Ruiz 2024-02-29 18:21:17 +00:00
parent fe07e9842e
commit 3b92faa5cf
3 changed files with 10 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -37,13 +37,13 @@ To run the local development server, first clone this repo.
Install dependencies: Install dependencies:
```bash ```bash
yarn i yarn
``` ```
Start the local development server: Start the local development server:
```bash ```bash
yarn run dev yarn dev
``` ```
Open the example project at `localhost:5420`. Open the example project at `localhost:5420`.

3
packages/namespaced-tldraw/README.md
View file

@ -1,4 +1,3 @@
# @tldraw/tldraw # @tldraw/tldraw
This package is kept around for legacy purposes, and just tracks the normal `tldraw` package. Please This package is kept around for legacy purposes. It just tracks the normal `tldraw` package. Please install that one instead.
install that one instead.

24
packages/tldraw/README.md
View file

@ -11,30 +11,20 @@ This package contains the source code for the tldraw library. Learn more at our
## Installation ## Installation
Install the `tldraw` package using `@canary` for the latest canary release. (Or `@alpha` for the latest alpha release.) Install the `tldraw` package.
```bash ```bash
yarn add tldraw@canary npm i tldraw
# or
npm install tldraw@canary
# or
pnpm i tldraw@canary
``` ```
Then start the local development server. Then start the local development server.
```bash ```bash
yarn dev
# or
npm run dev npm run dev
# or
pnpm dev
``` ```
## Usage ## Usage
An extremely minimal usage (without our UI) might look like this:
```tsx ```tsx
import { Tldraw } from 'tldraw' import { Tldraw } from 'tldraw'
import 'tldraw/tldraw.css' import 'tldraw/tldraw.css'
@ -44,7 +34,7 @@ export default function () {
} }
``` ```
See the [examples folder](https://github.com/tldraw/tldraw/tree/main/apps/examples) for more examples. Visit or [docs site](https://tldraw.dev) to learn more. See our [examples folder](https://github.com/tldraw/tldraw/tree/main/apps/examples) for more examples.
## Community ## Community
@ -60,14 +50,14 @@ Please see our [contributing guide](https://github.com/tldraw/tldraw/blob/main/C
## License ## License
The tldraw source code and its distributions are provided under the [tldraw license](https://github.com/tldraw/tldraw/blob/master/LICENSE.md). This license does not permit commercial use. The tldraw source code and its distributions are provided under the [tldraw license](https://github.com/tldraw/tldraw/blob/main/LICENSE.md). This license does not permit commercial use.
If you wish to use this project in commercial product, you need to purchase a commercial license. Please contact us at [hello@tldraw.com](mailto:hello@tldraw.com) for more inforion about obtaining a commercial license. If you wish to use this project in commercial product, you need to purchase a commercial license. Please contact us at [sales@tldraw.com](mailto:sales@tldraw.com) for more inforion about obtaining a commercial license.
## Trademarks ## Trademarks
Copyright (c) 2023-present tldraw Inc. The tldraw name and logo are trademarks of tldraw. Please see our [trademark guidelines](https://github.com/tldraw/tldraw/blob/main/TRADEMARKS.md) for info on acceptable usage. Copyright (c) 2024-present tldraw Inc. The tldraw name and logo are trademarks of tldraw. Please see our [trademark guidelines](https://github.com/tldraw/tldraw/blob/main/TRADEMARKS.md) for info on acceptable usage.
## Contact ## Contact
Find us on Twitter at [@tldraw](https://twitter.com/tldraw) or email [hello@tldraw.com](mailto://hello@tldraw.com). You can also [join our discord](https://discord.gg/rhsyWMUJxd) for quick help and support. Find us on Twitter at [@tldraw](https://twitter.com/tldraw) or email [sales@tldraw.com](mailto://sales@tldraw.com). You can also [join our discord](https://discord.gg/rhsyWMUJxd) for quick help and support.