From 549afdc0d66fa822a0af2fec839ba87ceed4798c Mon Sep 17 00:00:00 2001 From: brianuribe6 Date: Wed, 20 Mar 2024 18:10:49 -0400 Subject: [PATCH] Update Readme --- README.md | 88 ++++++++++--------------------------------------------- 1 file changed, 15 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index ed72568..d6fd913 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,23 @@ -# Turborepo starter +# Jotter -This is an official starter Turborepo. +Jotter is a collaborative text editor that focuses on simplicity and your +productivity. It features a clean toolbar-free user interface that helps you +keep your hands where they are more useful **on the keyboard.** -## Using this example +![A Jotter notebook](https://github.com/jot-it/jotter/assets/45882589/de4ce39a-095e-4e57-b748-d7e72b287a29) -Run the following command: +## Features -```sh -npx create-turbo@latest -``` +- Realtime collaboration +- Markdown support +- Keyboard shortcuts +- `/` Commands for text formatting +- Syntax highlighting for code blocks -## What's inside? +## Contributing -This Turborepo includes the following packages/apps: +See the [contributing guide](/CONTRIBUTING.md) -### Apps and Packages +## License -- `docs`: a [Next.js](https://nextjs.org/) app -- `web`: another [Next.js](https://nextjs.org/) app -- `@jotter/ui`: a stub React component library shared by both `web` and `docs` applications -- `@jotter/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) -- `@jotter/typescript-config`: `tsconfig.json`s used throughout the monorepo - -Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). - -### Utilities - -This Turborepo has some additional tools already setup for you: - -- [TypeScript](https://www.typescriptlang.org/) for static type checking -- [ESLint](https://eslint.org/) for code linting -- [Prettier](https://prettier.io) for code formatting - -### Build - -To build all apps and packages, run the following command: - -``` -cd my-turborepo -pnpm build -``` - -### Develop - -To develop all apps and packages, run the following command: - -``` -cd my-turborepo -pnpm dev -``` - -### Remote Caching - -Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines. - -By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands: - -``` -cd my-turborepo -npx turbo login -``` - -This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview). - -Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo: - -``` -npx turbo link -``` - -## Useful Links - -Learn more about the power of Turborepo: - -- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks) -- [Caching](https://turbo.build/repo/docs/core-concepts/caching) -- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) -- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering) -- [Configuration Options](https://turbo.build/repo/docs/reference/configuration) -- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference) +Licensed under the [MIT License](/LICENSE)