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

55 lines
2.1 KiB
Markdown
Raw Normal View History

transfer-out: transfer out
2023-04-25 11:01:25 +00:00
<div alt style="text-align: center; transform: scale(.5);">
<picture>
add descriptions to examples (#2375) Adds descriptions to examples. ![Kapture 2023-12-22 at 17 08 32](https://github.com/tldraw/tldraw/assets/1489520/d78657cf-b3c3-4160-b58b-7c08ed27823d) They show as a list on the index page, and on individual examples they show in a three-js style sidebar. For now, this is disabled completely on mobile. Examples can still be opened in 'standalone' mode to get rid of the sidebar. Note: the 'view code' link won't work until after these changes are merged. There's a small impact on authoring examples: each one needs to live in a folder with a README.md. At a minimum, the readme needs to look like this: ```md --- title: My Example component: ./MyExample.tsx --- Here is a 1-liner about my example ``` Optionally, you can: - Add `hide: true` to the frontmatter to remove the example from the list (you can skip the description this way) - Add `order: 3` to control the order in which the example appears. They're alphabetical otherwise - Add some more description or links to docs below a `---`. This won't show in the listing, but will be visible on GitHub and on the example page itself. As a follow-up, I'd like to add an 'Open in CodeSandbox' link to each example. These won't work until we've made a release with these examples (as our special examples codesandbox is tied to our release process) but the code is there & ready to go! Have a play, let me know what you think! ### Change Type - [x] `documentation` — Changes to the documentation only[^2] --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-12-27 17:17:18 +00:00
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tldraw/tldraw/main/assets/github-hero-dark-2.png"/>
<img alt="tldraw" src="https://raw.githubusercontent.com/tldraw/tldraw/main/assets/github-hero-light-2.png"/>
transfer-out: transfer out
2023-04-25 11:01:25 +00:00
</picture>
</div>
[improvement] readme / contributing (#1199) This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like! ![image](https://user-images.githubusercontent.com/15892272/234321088-6bde4a16-5c9d-4d74-985b-fc578d374eb9.png) --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-05-03 08:32:52 +00:00
# tldraw
Change licenses to tldraw (#2167) This PR updates the licenses across tldraw to a bespoke tldraw license. The idea here is leverage dual licensing for revenue from companies using tldraw. The source code and its distributions are provided under a non-commercial license (tldraw) while we offer to sell / give out an alternative exclusive-use license for companies who wish to use the product for commercial purposes. - [x] Add new license - [x] Change licenses in package.jsons - [x] Update READMEs - [x] Update docs (separate repo PR) - [x] Have alternative license in hand (US) - [ ] Have alternative license in hand (UK) - [x] Have sales contract in hand (US) - [ ] Have sales contract in hand (UK) ### Change Type - [x] `major` — Breaking change
2023-12-19 10:41:01 +00:00
Welcome to the public monorepo for [tldraw](https://github.com/tldraw/tldraw). tldraw is an open source library for creating infinite canvas experiences in React. It's the software behind the digital whiteboard [tldraw.com](https://tldraw.com).
[improvement] readme / contributing (#1199) This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like! ![image](https://user-images.githubusercontent.com/15892272/234321088-6bde4a16-5c9d-4d74-985b-fc578d374eb9.png) --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-05-03 08:32:52 +00:00
Change licenses to tldraw (#2167) This PR updates the licenses across tldraw to a bespoke tldraw license. The idea here is leverage dual licensing for revenue from companies using tldraw. The source code and its distributions are provided under a non-commercial license (tldraw) while we offer to sell / give out an alternative exclusive-use license for companies who wish to use the product for commercial purposes. - [x] Add new license - [x] Change licenses in package.jsons - [x] Update READMEs - [x] Update docs (separate repo PR) - [x] Have alternative license in hand (US) - [ ] Have alternative license in hand (UK) - [x] Have sales contract in hand (US) - [ ] Have sales contract in hand (UK) ### Change Type - [x] `major` — Breaking change
2023-12-19 10:41:01 +00:00
👉 Read the docs and learn more at [tldraw.dev](https://tldraw.dev).
[improvement] readme / contributing (#1199) This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like! ![image](https://user-images.githubusercontent.com/15892272/234321088-6bde4a16-5c9d-4d74-985b-fc578d374eb9.png) --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-05-03 08:32:52 +00:00
## Local development
To run the local development server, first clone this repo.
Install dependencies:
```bash
yarn
```
Start the local development server:
```bash
yarn dev
```
Open the example project at `localhost:5420`.
Change licenses to tldraw (#2167) This PR updates the licenses across tldraw to a bespoke tldraw license. The idea here is leverage dual licensing for revenue from companies using tldraw. The source code and its distributions are provided under a non-commercial license (tldraw) while we offer to sell / give out an alternative exclusive-use license for companies who wish to use the product for commercial purposes. - [x] Add new license - [x] Change licenses in package.jsons - [x] Update READMEs - [x] Update docs (separate repo PR) - [x] Have alternative license in hand (US) - [ ] Have alternative license in hand (UK) - [x] Have sales contract in hand (US) - [ ] Have sales contract in hand (UK) ### Change Type - [x] `major` — Breaking change
2023-12-19 10:41:01 +00:00
## License
[improvement] readme / contributing (#1199) This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like! ![image](https://user-images.githubusercontent.com/15892272/234321088-6bde4a16-5c9d-4d74-985b-fc578d374eb9.png) --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-05-03 08:32:52 +00:00
Fix license language. (#2365) Bleh ### Change Type - [x] `internal` — Any other changes that don't affect the published package[^2]
2023-12-20 16:08:50 +00:00
tldraw's source code and distributed packages are provided under the non-commercial [tldraw license](https://github.com/tldraw/tldraw/blob/master/LICENSE.md).
[improvement] readme / contributing (#1199) This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like! ![image](https://user-images.githubusercontent.com/15892272/234321088-6bde4a16-5c9d-4d74-985b-fc578d374eb9.png) --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-05-03 08:32:52 +00:00
Fix license language. (#2365) Bleh ### Change Type - [x] `internal` — Any other changes that don't affect the published package[^2]
2023-12-20 16:08:50 +00:00
This license does not permit commercial use. If you wish to use tldraw in a commercial product or enterprise, you will need to purchase a commercial license. To obtain a commercial license, please contact us at [hello@tldraw.com](mailto:hello@tldraw.com).
[improvement] readme / contributing (#1199) This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like! ![image](https://user-images.githubusercontent.com/15892272/234321088-6bde4a16-5c9d-4d74-985b-fc578d374eb9.png) --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-05-03 08:32:52 +00:00
Fix license language. (#2365) Bleh ### Change Type - [x] `internal` — Any other changes that don't affect the published package[^2]
2023-12-20 16:08:50 +00:00
To learn more, see our [license](https://tldraw.dev/community/license) page.
[improvement] readme / contributing (#1199) This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like! ![image](https://user-images.githubusercontent.com/15892272/234321088-6bde4a16-5c9d-4d74-985b-fc578d374eb9.png) --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-05-03 08:32:52 +00:00
Change licenses to tldraw (#2167) This PR updates the licenses across tldraw to a bespoke tldraw license. The idea here is leverage dual licensing for revenue from companies using tldraw. The source code and its distributions are provided under a non-commercial license (tldraw) while we offer to sell / give out an alternative exclusive-use license for companies who wish to use the product for commercial purposes. - [x] Add new license - [x] Change licenses in package.jsons - [x] Update READMEs - [x] Update docs (separate repo PR) - [x] Have alternative license in hand (US) - [ ] Have alternative license in hand (UK) - [x] Have sales contract in hand (US) - [ ] Have sales contract in hand (UK) ### Change Type - [x] `major` — Breaking change
2023-12-19 10:41:01 +00:00
## Trademarks
[improvement] readme / contributing (#1199) This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like! ![image](https://user-images.githubusercontent.com/15892272/234321088-6bde4a16-5c9d-4d74-985b-fc578d374eb9.png) --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-05-03 08:32:52 +00:00
Fix README link typo (#2372) Trademark link was mistyped. ### Change Type - [x] `documentation` — Changes to the documentation only
2023-12-22 13:28:53 +00:00
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.
[improvement] readme / contributing (#1199) This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like! ![image](https://user-images.githubusercontent.com/15892272/234321088-6bde4a16-5c9d-4d74-985b-fc578d374eb9.png) --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-05-03 08:32:52 +00:00
## Community
Have questions, comments or feedback? [Join our discord](https://discord.gg/rhsyWMUJxd) or [start a discussion](https://github.com/tldraw/tldraw/discussions/new).
Update README.md (#1331) Add some unhappy but necessary language to our readme's licensing and contributing sections.
2023-05-08 19:28:53 +00:00
## Contribution
Please see our [contributing guide](https://github.com/tldraw/tldraw/blob/main/CONTRIBUTING.md). Found a bug? Please [submit an issue](https://github.com/tldraw/tldraw/issues/new).
[improvement] readme / contributing (#1199) This PR adds a barebones Readme to the public repo that we can start to iterate on. This is what it looks like! ![image](https://user-images.githubusercontent.com/15892272/234321088-6bde4a16-5c9d-4d74-985b-fc578d374eb9.png) --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-05-03 08:32:52 +00:00
## 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.
Reference in a new issue Copy permalink