diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f833f5cae..3be0fc695 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,6 +75,6 @@ When you're finished with the changes, create a pull request, also known as a PR ### Your PR is merged! -Congratulations :tada::tada: The GitHub team thanks you :sparkles:. +Congratulations :tada::tada: The tldraw team thanks you :sparkles:. Once your PR is merged, your contributions will become part of the next tldraw release, and will be visible in the [tldraw app](https://tldraw.com). diff --git a/README.md b/README.md index 18dc69649..bcbe72942 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ This repository is a monorepo containing two packages: - [**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 ``. 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. -...and three apps: +...and two apps: - [**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). diff --git a/packages/core/README.md b/packages/core/README.md index 75894c5e1..176e70866 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -24,9 +24,9 @@ npm i @tldraw/core There are two examples in this repository. -The **simple** example in the `example` folder shows a minimal use of the library. It does not do much but this should be a good reference for the API without too much else built on top. +The **simple** example in [`examples/core-example`](https://github.com/tldraw/tldraw/tree/main/examples/core-example) shows a minimal use of the library. It does not do much but this should be a good reference for the API without too much else built on top. -The **advanced** example in the `example-advanced` folder shows a more realistic use of the library. (Try it [here](https://core-steveruiz.vercel.app/)). While the fundamental patterns are the same, this example contains features such as: panning, pinching, and zooming the camera; creating, cloning, resizing, and deleting shapes; keyboard shortcuts, brush-selection; shape-snapping; undo, redo; and more. Much of the code in the advanced example comes from the [@tldraw/tldraw](https://tldraw.com) codebase. +The **advanced** example in [`examples/core-example-advanced`](https://github.com/tldraw/tldraw/tree/main/examples/core-example-advanced) shows a more realistic use of the library. (Try it [here](https://core-steveruiz.vercel.app/)). While the fundamental patterns are the same, this example contains features such as: panning, pinching, and zooming the camera; creating, cloning, resizing, and deleting shapes; keyboard shortcuts, brush-selection; shape-snapping; undo, redo; and more. Much of the code in the advanced example comes from the [@tldraw/tldraw](https://tldraw.com) codebase. If you're working on an app that uses this library, I recommend referring back to the advanced example for tips on how you might implement these features for your own project. diff --git a/packages/tldraw/README.md b/packages/tldraw/README.md index 590d17311..0b1b15e49 100644 --- a/packages/tldraw/README.md +++ b/packages/tldraw/README.md @@ -17,11 +17,10 @@ This repository is a monorepo containing two packages: - [**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 ``. 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. -...and three apps: +...and two apps: - [**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: diff --git a/packages/vec/src/index.ts b/packages/vec/src/index.ts index ba392dba3..d4764d1d2 100644 --- a/packages/vec/src/index.ts +++ b/packages/vec/src/index.ts @@ -517,7 +517,7 @@ export class Vec { } /** - * Get an array of points (with simulated pressure) between two points. + * Get an array of points between two points. * @param A The first point. * @param B The second point. * @param steps The number of points to return.