Skip to content

Commit 6a0bc05

Browse files
docs: change README
1 parent f1ef4e8 commit 6a0bc05

File tree

1 file changed

+8
-70
lines changed

1 file changed

+8
-70
lines changed

README.md

+8-70
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,15 @@
1-
# Turborepo starter
1+
# Presage
22

3-
This is an official Yarn v1 starter turborepo.
3+
A Medium alternative built for referral podcasts and blogs [joinpresage.com](https://joinpresage.com)
44

5-
## What's inside?
5+
## Development
66

7-
This turborepo uses [Yarn](https://classic.yarnpkg.com/lang/en/) as a package manager. It includes the following packages/apps:
7+
All packages (web, api, etc.) are under `packages/`. When starting the api, run `yarn watch` and `yarn dev`.
88

9-
### Apps and Packages
9+
When contributing code, please checkout our [Figma file](https://www.figma.com/file/zPd9BYz6uGH4SxuANFGKvM/Presage).
1010

11-
- `docs`: a [Next.js](https://nextjs.org) app
12-
- `web`: another [Next.js](https://nextjs.org) app
13-
- `ui`: a stub React component library shared by both `web` and `docs` applications
14-
- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
15-
- `tsconfig`: `tsconfig.json`s used throughout the monorepo
11+
## Contact & Other Details
1612

17-
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
13+
If you want to get in touch for investing, contributing, or joining our platform, please DM us on twitter [@joinpresage](https://twitter.com/joinpresage) or email use [[email protected]](mailto:[email protected])
1814

19-
### Utilities
20-
21-
This turborepo has some additional tools already setup for you:
22-
23-
- [TypeScript](https://www.typescriptlang.org/) for static type checking
24-
- [ESLint](https://eslint.org/) for code linting
25-
- [Prettier](https://prettier.io) for code formatting
26-
27-
## Setup
28-
29-
This repository is used in the `npx create-turbo` command, and selected when choosing which package manager you wish to use with your monorepo (Yarn).
30-
31-
### Build
32-
33-
To build all apps and packages, run the following command:
34-
35-
```
36-
cd my-turborepo
37-
yarn run build
38-
```
39-
40-
### Develop
41-
42-
To develop all apps and packages, run the following command:
43-
44-
```
45-
cd my-turborepo
46-
yarn run dev
47-
```
48-
49-
### Remote Caching
50-
51-
Turborepo can use a technique known as [Remote Caching](https://turborepo.org/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
52-
53-
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:
54-
55-
```
56-
cd my-turborepo
57-
npx turbo login
58-
```
59-
60-
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
61-
62-
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
63-
64-
```
65-
npx turbo link
66-
```
67-
68-
## Useful Links
69-
70-
Learn more about the power of Turborepo:
71-
72-
- [Pipelines](https://turborepo.org/docs/core-concepts/pipelines)
73-
- [Caching](https://turborepo.org/docs/core-concepts/caching)
74-
- [Remote Caching](https://turborepo.org/docs/core-concepts/remote-caching)
75-
- [Scoped Tasks](https://turborepo.org/docs/core-concepts/scopes)
76-
- [Configuration Options](https://turborepo.org/docs/reference/configuration)
77-
- [CLI Usage](https://turborepo.org/docs/reference/command-line-reference)
15+
We plan on launching sometime this fall (2021) and to apply to YC S22.

0 commit comments

Comments
 (0)