Skip to content

Commit cd722b2

Browse files
committed
docs: changelogs cleanup
1 parent a111c3c commit cd722b2

6 files changed

Lines changed: 216 additions & 828 deletions

File tree

packages/better-svelte-email/CHANGELOG.md

Lines changed: 36 additions & 138 deletions
Original file line numberDiff line numberDiff line change
@@ -4,114 +4,62 @@
44

55
### Major Changes
66

7-
- b41cc08: # New in v2
7+
### New in v2
88

9-
A CLI (`npx @better-svelte-email/cli`) has been added to preview your emails locally. It replaces the old preview system.
9+
A CLI (`npx @better-svelte-email/cli`) has been added to preview your emails locally. It replaces the old preview system.
1010

11-
I also have migrated the codebase to a monorepo with new isolated packages (ex: @better-svelte-email/preview, @better-svelte-email/server, @better-svelte-email/components) instead of a single package. This allows for better isolation and modularity, making it easier to maintain and update the different parts of the library. It also reduces the bundle size of the library, when you only need to install the packages you need.
11+
I also have migrated the codebase to a monorepo with new isolated packages (ex: @better-svelte-email/preview, @better-svelte-email/server, @better-svelte-email/components) instead of a single package. This allows for better isolation and modularity, making it easier to maintain and update the different parts of the library. It also reduces the bundle size of the library, when you only need to install the packages you need.
1212

13-
## Breaking Changes
13+
### Breaking Changes
1414

15-
The `better-svelte-email` package is now deprecated. You should use the new isolated packages instead.
16-
See the migration guide below for more details.
15+
The `better-svelte-email` package is now deprecated. You should use the new isolated packages instead.
16+
See the migration guide below for more details.
1717

18-
## Migration Guide
18+
### Migration Guide
1919

20-
### Update your dependencies
20+
### Update your dependencies
2121

22-
First, uninstall the old package:
22+
First, uninstall the old package:
2323

24-
```bash
25-
npm uninstall better-svelte-email
26-
```
24+
```bash
25+
npm uninstall better-svelte-email
26+
```
2727

28-
Then, install the new packages:
28+
Then, install the new packages:
2929

30-
```bash
31-
npm install @better-svelte-email/components @better-svelte-email/server
32-
```
30+
```bash
31+
npm install @better-svelte-email/components @better-svelte-email/server
32+
```
3333

34-
If you are using the preview system, you will need to install the preview package:
34+
If you are using the preview system, you will need to install the preview package:
3535

36-
```bash
37-
npm install @better-svelte-email/preview
38-
```
36+
```bash
37+
npm install @better-svelte-email/preview
38+
```
3939

40-
### Update your imports
40+
### Update your imports
4141

42-
You will need to update all your imports across your project to use the new packages.
42+
You will need to update all your imports across your project to use the new packages.
4343

44-
For the renderer, import it from the server package:
44+
For the renderer, import it from the server package:
4545

46-
```typescript
47-
import { Renderer } from '@better-svelte-email/server';
48-
```
46+
```typescript
47+
import { Renderer } from '@better-svelte-email/server';
48+
```
4949

50-
For the components, import them from the components package:
50+
For the components, import them from the components package:
5151

52-
```typescript
53-
import { Button, Text, Heading, Container, Section } from '@better-svelte-email/components';
54-
```
52+
```typescript
53+
import { Button, Text, Heading, Container, Section } from '@better-svelte-email/components';
54+
```
5555

56-
For the preview, import it from the preview package:
56+
For the preview, import it from the preview package:
5757

58-
```typescript
59-
import { EmailPreview } from '@better-svelte-email/preview';
60-
```
58+
```typescript
59+
import { EmailPreview } from '@better-svelte-email/preview';
60+
```
6161

62-
And that's it!
63-
64-
- 4825786: # New in v2
65-
66-
A CLI (`npx @better-svelte-email/cli`) has been added to preview your emails locally. It replaces the old preview system.
67-
68-
I also have migrated the codebase to a monorepo with new isolated packages (ex: @better-svelte-email/preview, @better-svelte-email/server, @better-svelte-email/components) instead of a single package. This allows for better isolation and modularity, making it easier to maintain and update the different parts of the library. It also reduces the bundle size of the library, when you only need to install the packages you need.
69-
70-
## Migration Guide
71-
72-
### Update your dependencies
73-
74-
First, uninstall the old package:
75-
76-
```bash
77-
npm uninstall better-svelte-email
78-
```
79-
80-
Then, install the new packages:
81-
82-
```bash
83-
npm install @better-svelte-email/components @better-svelte-email/server
84-
```
85-
86-
If you are using the preview system, you will need to install the preview package:
87-
88-
```bash
89-
npm install @better-svelte-email/preview
90-
```
91-
92-
### Update your imports
93-
94-
You will need to update all your imports across your project to use the new packages.
95-
96-
For the renderer, import it from the server package:
97-
98-
```typescript
99-
import { Renderer } from '@better-svelte-email/server';
100-
```
101-
102-
For the components, import them from the components package:
103-
104-
```typescript
105-
import { Button, Text, Heading, Container, Section } from '@better-svelte-email/components';
106-
```
107-
108-
For the preview, import it from the preview package:
109-
110-
```typescript
111-
import { EmailPreview } from '@better-svelte-email/preview';
112-
```
113-
114-
And that's it!
62+
And that's it!
11563

11664
### Patch Changes
11765

@@ -185,57 +133,7 @@
185133

186134
### Major Changes
187135

188-
- 4825786: # New in v2
189-
190-
A CLI (`npx @better-svelte-email/cli`) has been added to preview your emails locally. It replaces the old preview system.
191-
192-
I've also migrated the codebase to a monorepo with new isolated packages (ex: @better-svelte-email/preview, @better-svelte-email/server, @better-svelte-email/components) instead of a single package. This allows for better isolation and modularity, making it easier to maintain and update the different parts of the library. It also reduces the bundle size of the library, when you only need to install the packages you need.
193-
194-
## Migration Guide
195-
196-
### Update your dependencies
197-
198-
First, uninstall the old package:
199-
200-
```bash
201-
npm uninstall better-svelte-email
202-
```
203-
204-
Then, install the new packages:
205-
206-
```bash
207-
npm install @better-svelte-email/components @better-svelte-email/server
208-
```
209-
210-
If you are using the preview system, you will need to install the preview package:
211-
212-
```bash
213-
npm install @better-svelte-email/preview
214-
```
215-
216-
### Update your imports
217-
218-
You will need to update all your imports across your project to use the new packages.
219-
220-
For the renderer, import it from the server package:
221-
222-
```typescript
223-
import { Renderer } from '@better-svelte-email/server';
224-
```
225-
226-
For the components, import them from the components package:
227-
228-
```typescript
229-
import { Button, Text, Heading, Container, Section } from '@better-svelte-email/components';
230-
```
231-
232-
For the preview, import it from the preview package:
233-
234-
```typescript
235-
import { EmailPreview } from '@better-svelte-email/preview';
236-
```
237-
238-
And that's it!
136+
- 4825786: v2 beta initial release
239137

240138
### Patch Changes
241139

0 commit comments

Comments
 (0)