Update READMEs (#290)
* Update readmes * tweak links * Update README.md
This commit is contained in:
Steve Ruiz
GitHub
parent
9158666a09
commit
e542f1fde5
14 changed files with 46 additions and 1835 deletions
18
README.md
18
README.md
|
|
@ -12,20 +12,20 @@ Welcome to the [tldraw](https://tldraw.com) monorepo. Here you'll find the sourc
|
|||
|
||||
This repository is a monorepo containing two packages:
|
||||
|
||||
- **packages/tldraw** contains the source for the [@tldraw/tldraw](https://www.npmjs.com/package/@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](https://www.npmjs.com/package/@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.
|
||||
- [**packages/tldraw**](https://github.com/tldraw/tldraw/tree/main/packages/tldraw) contains the source for the [@tldraw/tldraw](https://www.npmjs.com/package/@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**](https://github.com/tldraw/tldraw/tree/main/packages/core) contains the source for the [@tldraw/core](https://www.npmjs.com/package/@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.
|
||||
|
||||
...three apps:
|
||||
...and three apps:
|
||||
|
||||
- **apps/www** contains the source for the [tldraw.com](https://tldraw.com) website.
|
||||
- **apps/vscode** contains the source for the [tldraw VS Code extension](https://marketplace.visualstudio.com/items?itemName=tldraw-org.tldraw-vscode).
|
||||
- **apps/electron** contains the source for an experimental Electron app.
|
||||
- [**apps/www**](https://github.com/tldraw/tldraw/tree/main/apps/www) contains the source for the [tldraw.com](https://tldraw.com) website.
|
||||
- [**apps/vscode**](https://github.com/tldraw/tldraw/tree/main/apps/vscode) contains the source for the [tldraw VS Code extension](https://marketplace.visualstudio.com/items?itemName=tldraw-org.tldraw-vscode).
|
||||
- [**apps/electron**](https://github.com/tldraw/tldraw/tree/main/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`.
|
||||
- [**examples/core-example**](https://github.com/tldraw/tldraw/tree/main/examples/core-example) is a simple example for `@tldraw/core`.
|
||||
- [**examples/core-example-advanced**](https://github.com/tldraw/tldraw/tree/main/examples/core-example-advanced) is a second example for `@tldraw/core`.
|
||||
- [**examples/tldraw-example**](https://github.com/tldraw/tldraw/tree/main/examples/tldraw-example) is an example for `@tldraw/tldraw`.
|
||||
|
||||
## Contribution
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,9 @@
|
|||
# @tldraw/tldraw-electron
|
||||
<div style="text-align: center; transform: scale(.5);">
|
||||
<img src="card-repo.png"/>
|
||||
</div>
|
||||
|
||||
An electron wrapper for tldraw. Not yet published.
|
||||
# @tldraw/electron
|
||||
|
||||
## Development
|
||||
An experimental electron wrapper for [tldraw](https://tldraw.com).
|
||||
|
||||
From the root of the repository, run:
|
||||
|
||||
```bash
|
||||
yarn start:vscode
|
||||
```
|
||||
Not yet distributed.
|
||||
|
|
|
|||
BIN
apps/electron/card-repo.png
Normal file
BIN
apps/electron/card-repo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
|
|
@ -1 +1,7 @@
|
|||
## tldraw/web
|
||||
<div style="text-align: center; transform: scale(.5);">
|
||||
<img src="card-repo.png"/>
|
||||
</div>
|
||||
|
||||
# @tldraw/www
|
||||
|
||||
The [tldraw](https://tldraw.com) website.
|
||||
|
|
|
|||
BIN
apps/www/card-repo.png
Normal file
BIN
apps/www/card-repo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
|
|
@ -1,8 +1,12 @@
|
|||
# @tldraw/core Advanced Example
|
||||
<div style="text-align: center; transform: scale(.5);">
|
||||
<img src="card-repo.png"/>
|
||||
</div>
|
||||
|
||||
# @tldraw/core-example-advanced
|
||||
|
||||
An advanced example project for `@tldraw/core`.
|
||||
|
||||
To start this project:
|
||||
|
||||
- run `yarn start` in the root directory
|
||||
- run `yarn start:core` from the repository's root directory
|
||||
- open `http://localhost:5420` in your browser
|
||||
|
|
|
|||
BIN
examples/core-example-advanced/card-repo.png
Normal file
BIN
examples/core-example-advanced/card-repo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
|
|
@ -1,8 +1,3 @@
|
|||
# @tldraw/core Simple Example
|
||||
|
||||
A (relatively) simple example project for `@tldraw/core`.
|
||||
|
||||
To start this project:
|
||||
|
||||
- run `yarn start:simple` in the root directory
|
||||
- open `http://localhost:5420` in your browser
|
||||
|
|
|
|||
BIN
examples/core-example/card-repo.png
Normal file
BIN
examples/core-example/card-repo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
|
|
@ -1,6 +1,12 @@
|
|||
<div style="text-align: center; transform: scale(.5);">
|
||||
<img src="card-repo.png"/>
|
||||
</div>
|
||||
|
||||
# @tldraw/tldraw-example
|
||||
|
||||
An example for @tldraw/tldraw with a very fast dev server.
|
||||
An example project for `@tldraw/tldraw`.
|
||||
|
||||
**Note:** You probably do not need to start the server here: it is started as
|
||||
part of `yarn start` in the root directory.
|
||||
To start this project:
|
||||
|
||||
- run `yarn start` from the repository's root directory
|
||||
- open `http://localhost:5420` in your browser
|
||||
|
|
|
|||
BIN
examples/tldraw-example/card-repo.png
Normal file
BIN
examples/tldraw-example/card-repo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
File diff suppressed because it is too large
Load diff
|
|
@ -460,15 +460,17 @@ See the `example` folder or this [CodeSandbox](https://codesandbox.io/s/laughing
|
|||
|
||||
### Support
|
||||
|
||||
Need help? Please [open an issue](https://github.com/tldraw/core/issues/new) for support.
|
||||
Need help? Please [open an issue](https://github.com/tldraw/tldraw/issues/new) for support.
|
||||
|
||||
### Discussion
|
||||
|
||||
Want to connect with other devs? Visit the [Discord channel](https://discord.gg/s4FXZ6fppJ).
|
||||
Want to connect with other devs? Visit the [Discord channel](https://discord.gg/SBBEVCA4PG).
|
||||
|
||||
### License
|
||||
|
||||
This project is licensed under MIT. If you're using the library in a commercial product, please consider [becoming a sponsor](https://github.com/sponsors/steveruizok?frequency=recurring&sponsor=steveruizok).
|
||||
This project is licensed under MIT.
|
||||
|
||||
If you're using the library in a commercial product, please consider [becoming a sponsor](https://github.com/sponsors/steveruizok?frequency=recurring&sponsor=steveruizok).
|
||||
|
||||
## Author
|
||||
|
||||
|
|
|
|||
|
|
@ -76,11 +76,11 @@ function App() {
|
|||
}
|
||||
```
|
||||
|
||||
Internally, the `<Tldraw/>` component's user interface uses this API to make changes to the component's state. See the `tldrawApp` section of the [documentation](guides/documentation) for more on this API.
|
||||
Internally, the `<Tldraw/>` component's user interface uses this API to make changes to the component's state. See the `tldrawApp` section of the [documentation](packages/tldraw/guides/documentation.md) for more on this API.
|
||||
|
||||
### Responding to Changes
|
||||
|
||||
You can respond to changes and user actions using the `onChange` callback. For more specific changes, you can also use the `onPatch`, `onCommand`, or `onPersist` callbacks. See the [documentation](guides/documentation) for more.
|
||||
You can respond to changes and user actions using the `onChange` callback. For more specific changes, you can also use the `onPatch`, `onCommand`, or `onPersist` callbacks. See the [documentation](packages/tldraw/guides/documentation.md) for more.
|
||||
|
||||
```tsx
|
||||
import { Tldraw, TldrawApp } from '@tldraw/tldraw'
|
||||
|
|
@ -96,7 +96,7 @@ function App() {
|
|||
|
||||
## Documentation
|
||||
|
||||
See the project's [documentation](/packages/tldraw/guides/documentation.md).
|
||||
See the project's [documentation](packages/tldraw/guides/documentation.md).
|
||||
|
||||
## Contribution
|
||||
|
||||
|
|
@ -104,7 +104,7 @@ See the [contributing guide](/CONTRIBUTING.md).
|
|||
|
||||
## Development
|
||||
|
||||
See the [development guide](/packages/tldraw/guides/development.md).
|
||||
See the [development guide](packages/tldraw/guides/development.md).
|
||||
|
||||
## Example
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue