Skip to content

Commit 8aaa1cd

Browse files
committed
cleanup
1 parent 3dec94d commit 8aaa1cd

File tree

5 files changed

+147
-120
lines changed

5 files changed

+147
-120
lines changed

CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CHANGELOG
2+
3+
**Unpublished:**
4+
- Introduced CHANGELOG
5+
- npm package updates
6+
7+
**v0.1.0-alpha.0:**
8+
- Initial implementation

README.md

+24-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,28 @@
1-
# Templateless JavaScript
1+
<h1 align="center">
2+
<a href="https://templateless.com/">
3+
<img src="templateless.webp" alt="Templateless" width="450px">
4+
</a>
5+
<br />
6+
</h1>
7+
8+
<p align="center">
9+
<b>Ship faster by treating email as code 🚀</b> <br />
10+
</p>
11+
12+
<h4 align="center">
13+
<a href="https://templateless.com/">Website</a> &bull;
14+
<a href="https://app.templateless.com/">Get Your API Key</a> &bull;
15+
<a href="https://twitter.com/templateless">Twitter</a>
16+
</h4>
17+
18+
---
219

320
[![npm version](https://img.shields.io/npm/v/templateless-js.svg)](https://www.npmjs.com/package/templateless-js)
421
[![Github Actions](https://img.shields.io/github/actions/workflow/status/templateless/templateless-javascript/tests.yml)](https://github.com/templateless/templateless-javascript/actions)
522
[![Downloads](https://img.shields.io/npm/dm/templateless-js)](https://www.npmjs.com/package/templateless-js)
23+
[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/Templateless)](https://twitter.com/templateless)
624

7-
## What is Templateless?
8-
9-
[Templateless](https://templateless.com) lets you generate and send transactional emails quickly and easily so you can ship faster 🚀
25+
[Templateless](https://templateless.com) lets you generate and send transactional emails quickly and easily so you can focus on building your product.
1026

1127
## ✨ Features
1228

@@ -60,7 +76,10 @@ import { Content, Email, EmailAddress, Templateless } from 'templateless-js'
6076
})()
6177
```
6278

63-
Note:
79+
> **Note**
80+
> 🚧 **This SDK is not stable yet.** The API might change as more features are added. Please pay attention to the [CHANGELOG](CHANGELOG.md) for breaking changes.
81+
82+
Examples:
6483

6584
1. Get your **free API key** here: <https://app.templateless.com>
6685
1. There are more JavaScript examples in the [examples](examples) folder

0 commit comments

Comments
 (0)