Skip to content

Commit 6623bcc

Browse files
committed
docs: add README
1 parent 37f7aef commit 6623bcc

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Typescript multi package starter
2+
Starter for typescript monorepo.
3+
4+
## Get started
5+
- Clone repository:
6+
- with degit (clone without git history):
7+
```
8+
npx degit https://github.com/binier/typescript-multi-package-starter.git YOURFOLDERNAME
9+
```
10+
- with git:
11+
```
12+
git clone https://github.com/binier/typescript-multi-package-starter.git YOURFOLDERNAME
13+
```
14+
- Install dependecies:
15+
```
16+
yarn install
17+
```
18+
- Edit `name` and `respository.url` in **package.json** to your package
19+
name and it's repository url.
20+
- Edit `compilerOptions.paths` key from `@typescript-multi-package-starter/*`
21+
to `@nameOfYourPackage/*`.
22+
23+
Note: `nameOfYourPackage` should match `name` in **package.json**.
24+
25+
---
26+
27+
## Add package
28+
Add new package to monorepo using:
29+
```
30+
yarn package:add foo
31+
```
32+
Command creates new package under directory **packages/foo**

0 commit comments

Comments
 (0)